blob: 623d61d6be5fbf231e6251164d461b4e9563f6fd (
plain) (
tree)
|
|
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml" lang="" xml:lang="">
<head>
<meta charset="utf-8" />
<meta name="generator" content="pandoc" />
<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" />
<meta name="dcterms.date" content="2018-09-21" />
<title>Style Guide</title>
<style type="text/css">
code{white-space: pre-wrap;}
span.smallcaps{font-variant: small-caps;}
span.underline{text-decoration: underline;}
div.column{display: inline-block; vertical-align: top; width: 50%;}
</style>
<link rel="stylesheet" href="assets/lib/bootstrap/bootstrap.min.css">
<link rel="stylesheet" href="assets/lib/fontawesome/css/font-awesome.min.css">
<link rel="stylesheet" href="assets/stylesheets/main.css">
</head>
<body>
<header class="container">
<div style="text-align: center;">
<h1>Style Guide</h1>
<p class="subtitle">Software Engineering at Driver</p>
<nav class="my-4">
<a class="btn btn-light" href="css.html">
<img src="assets/images/css.svg" width="16px" class="img-fluid">
CSS
</a>
<a class="btn btn-light" href="git.html">
<img src="assets/images/git.png" width="16px" class="img-fluid">
Git
</a>
<a class="btn btn-light" href="html.html">
<img src="assets/images/html5.svg" width="16px" class="img-fluid">
HTML
</a>
<a class="btn btn-light" href="javascript.html">
<img src="assets/images/javascript.png" width="16px" class="img-fluid">
JavaScript
</a>
<a class="btn btn-light" href="scala.html">
<img src="assets/images/scala.png" width="16px" class="img-fluid">
Scala
</a>
<a class="btn btn-light" href="shell-script.html">
<img src="assets/images/bash.svg" width="16px" class="img-fluid">
Shell Script
</a>
</nav>
</div>
</header>
<div class="container">
This guide recommends stylistic and architectural best
practices, designed to make your code easier for others to
understand. It offers <em>guidelines</em> not <em>rules</em>,
and there are situations in which the advice offered
should be actively ignored.
<hr>
</div>
<main class="container">
<h2 id="git">Git</h2>
<ul>
<li><p>Use a simple branching model with one master development branch, and create feature and backport branches as required.</p>
<ul>
<li><p>The master branch should represent the latest development version.</p></li>
<li><p>Tag all released versions.</p></li>
<li><p>Backport branches may be spun off tags when they become necessary.</p></li>
</ul></li>
<li><p>Proposed changes require at least one sign-off to be accepted into master.</p></li>
<li><p>Large feature branches with multiple collaborators should be <em>merged</em> into master.</p>
<p>Rationale: rewriting history in public branches can break other people’s work and should not be done lightly.</p></li>
<li><p>Private feature branches should be <em>rebased</em> onto master, prior to merging. <em>Squashing</em> is optional, but all intermediate commits should contain meaningful changes and must pass continuous integration tests.</p>
<p>Rationale: private branches should be considered backups of work on local developer machines and hence should not be relied upon by others. Furthermore, a linear history is easier to reason about than a branched one.</p></li>
</ul>
</main>
<footer class="small mt-6 mb-1">
<span class="date">2018-09-21</span>
| <a href="https://github.com/drivergroup/best-practices/blob/master/guides/git.md" style="display: inline-block;"><i class="fa fa-github"></i> Edit on GitHub</a>
</footer>
</body>
</html>
|
