<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>CONTRIBUTE.md - collab/igvc2018 @ motor</title>
<meta name="description" content="CONTRIBUTE.md in collab/igvc2018 at motor.">
<meta property="og:title" content="CONTRIBUTE.md - collab/igvc2018 @ motor">
<meta property="og:description" content="CONTRIBUTE.md in collab/igvc2018 at motor.">
<meta property="og:type" content="website">
<meta property="og:site_name" content="git.julia.blue">
<link rel="stylesheet" href="/css/style.css?v=62">
<script type="module" src="/js/main.js?v=62"></script>
</head>
<body>
<main data-ref="motor" data-tip="a56a53dcb5658fb79fed5f915d80448ccc25b52b">
<noscript>
  <div class="callout">
    <p>
      hey! this is a static git repo viewer. commit diffs, file history,
      older commits and other revisions won't load without javascript.
    </p>
    <p>
      you are still able to view source files on branch/tag tips,
      but the experience is degraded.
    </p>
  </div>
</noscript>
<header class="repo"><div>
<h1>collab/igvc2018</h1>
</div>
<pre class="clone">git clone https://git.julia.blue/collab/igvc2018</pre>
</header>
<p class="snapshot-commit"><span class="commit-author">p1n3appl3</span><span class="commit-message" data-commit="36bc4497782e9524e0f964d77d43df7951beb5aa">Add gitignore, readme, license, and contributing guide</span><span class="snapshot-sha sha" data-commit="36bc4497782e9524e0f964d77d43df7951beb5aa">36bc449</span><time datetime="2017-10-27T17:21:15-05:00" title="2017-10-27 17:21:15 -0500">2017-10-27</time></p>
<header class="topbar"><details class="switcher"><summary>motor</summary><div class="menu"><strong>branches</strong><a href="/collab/igvc2018/ref/camera/">camera</a><a href="/collab/igvc2018/ref/documentation/">documentation</a><a href="/collab/igvc2018/ref/imu/">imu</a><a href="/collab/igvc2018/ref/master/">master</a><a class="current" href="/collab/igvc2018/ref/motor/">motor</a><a href="/collab/igvc2018/ref/simulation/">simulation</a><a class="all" href="/collab/igvc2018/refs">all refs →</a></div></details><nav class="crumbs"><a href="/collab/igvc2018/">igvc2018</a> / <span class="cur">CONTRIBUTE.md</span></nav>
<span class="view-stats"><span>1.7 KiB</span><span>16 lines</span></span><span class="actions"><a class="raw" href="/collab/igvc2018/raw/69ec854d60068f5e5701ec42f011c6f44eff744e/CONTRIBUTE.md">raw</a></span></header>
<div class="markdown-view"><input type="radio" name="markdown-view" id="markdown-rendered" checked><label for="markdown-rendered">rendered</label><input type="radio" name="markdown-view" id="markdown-code"><label for="markdown-code">code</label><section class="readme rendered"><h1>Contributing Guide</h1>
<blockquote>
<p>Chaos is inherent in all compound things. Strive on with diligence.</p>
</blockquote>
<blockquote>
<p>-Buddah</p>
</blockquote>
<p>If we want to do anything complex without it all crashing and burning, we need to be disciplined in how we develop our code. This guide will assume some familiarity with git, if anything is over your head just ask on the slack.</p>
<h2>Adding and changing code</h2>
<p>If you want to develop some feature of the code base there is one thing you need to remember above all else: <strong>MAKE BRANCHES</strong>. Messing with the IMU drivers? checkout an IMU branch. Editing this very file? checkout a housekeeping branch. Nothing that you write should ever be done directly on top of master. In fact, we have protected the master branch so that even if you have write permissions for the repo, you cannot push to master. This may sound like it's making your life unduly difficult for no reason, but months or years down the line, it's the only way to keep the history intelligible. Make sure to keep other branches up to date with <code>git fetch</code> and <code>git rebase origin/master</code>. When you're done with your code, test it, document it, get someone else to look at it, document it some more, and <em>then</em> open a PR with a full description of the changes.</p>
<h2>Documentation</h2>
<p>The rules are simple: if you don't write docstrings, your code doesn't get merged. Unless a function is obscenely simple, it probably needs a docstring. Commit messages are also documentation. They should be descriptive and to the point.</p>
<h2>Project management</h2>
<p>If you find a bug in the code, make an issue. If you aren't sure what needs to be worked on, check the issues. If you have an idea for a feature we should add, make an issue. Tag issues appropriately and make them readable.</p>
</section><div class="code-panel"><pre class="code src language-markdown"><span class="code-line"><a class="ln" id="L1" href="#L1">1</a><span class="code-text"><a-p>#</a-p> <a-tt>Contributing Guide</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L2" href="#L2">2</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L3" href="#L3">3</a><span class="code-text"><a-p>&gt; </a-p>Chaos is inherent in all compound things. Strive on with diligence.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L5" href="#L5">5</a><span class="code-text"><a-p>&gt; </a-p>-Buddah</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L7" href="#L7">7</a><span class="code-text">If we want to do anything complex without it all crashing and burning, we need to be disciplined in how we develop our code. This guide will assume some familiarity with git, if anything is over your head just ask on the slack.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L9" href="#L9">9</a><span class="code-text"><a-p>##</a-p> <a-tt>Adding and changing code</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text">If you want to develop some feature of the code base there is one thing you need to remember above all else: **MAKE BRANCHES**. Messing with the IMU drivers? checkout an IMU branch. Editing this very file? checkout a housekeeping branch. Nothing that you write should ever be done directly on top of master. In fact, we have protected the master branch so that even if you have write permissions for the repo, you cannot push to master. This may sound like it&#39;s making your life unduly difficult for no reason, but months or years down the line, it&#39;s the only way to keep the history intelligible. Make sure to keep other branches up to date with `git fetch` and `git rebase origin/master`. When you&#39;re done with your code, test it, document it, get someone else to look at it, document it some more, and _then_ open a PR with a full description of the changes.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L11" href="#L11">11</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L12" href="#L12">12</a><span class="code-text"><a-p>##</a-p> <a-tt>Documentation</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L13" href="#L13">13</a><span class="code-text">The rules are simple: if you don&#39;t write docstrings, your code doesn&#39;t get merged. Unless a function is obscenely simple, it probably needs a docstring. Commit messages are also documentation. They should be descriptive and to the point.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L14" href="#L14">14</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L15" href="#L15">15</a><span class="code-text"><a-p>##</a-p> <a-tt>Project management</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L16" href="#L16">16</a><span class="code-text">If you find a bug in the code, make an issue. If you aren&#39;t sure what needs to be worked on, check the issues. If you have an idea for a feature we should add, make an issue. Tag issues appropriately and make them readable.</span></span></pre></div></div>
</main>
</body>
</html>
