diff options
Diffstat (limited to 'docs/docs/Conventions.html')
| -rw-r--r-- | docs/docs/Conventions.html | 45 |
1 files changed, 35 insertions, 10 deletions
diff --git a/docs/docs/Conventions.html b/docs/docs/Conventions.html index 362292a..e1b3ac6 100644 --- a/docs/docs/Conventions.html +++ b/docs/docs/Conventions.html @@ -7,7 +7,8 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free -Documentation License." --> +Documentation License." + --> <!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> @@ -21,7 +22,7 @@ Documentation License." --> <link href="index.html" rel="start" title="Top"> <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> <link href="Contribution-Guidelines.html" rel="up" title="Contribution Guidelines"> -<link href="General-Conventions.html" rel="next" title="General Conventions"> +<link href="Shell-Conventions.html" rel="next" title="Shell Conventions"> <link href="Contribution-Guidelines.html" rel="prev" title="Contribution Guidelines"> <style type="text/css"> <!-- @@ -48,24 +49,48 @@ ul.no-bullet {list-style: none} <body lang="en"> <span id="Conventions"></span><div class="header"> <p> -Next: <a href="Sending-Git-mails.html" accesskey="n" rel="next">Sending Git mails</a>, Up: <a href="Contribution-Guidelines.html" accesskey="u" rel="up">Contribution Guidelines</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> +Up: <a href="Contribution-Guidelines.html" accesskey="u" rel="up">Contribution Guidelines</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> </div> <hr> -<span id="Conventions-1"></span><h3 class="section">4.1 Conventions</h3> +<span id="Conventions-1"></span><h3 class="section">3.1 Conventions</h3> + + + +<dl compact="compact"> +<dt>[<span id="g_t0010"></span>0010]</dt> +<dd><p>Try to keep the file readable. +</p><dl compact="compact"> +<dt>[<span id="g_t0011"></span>0011]</dt> +<dd><p>Characters on a line shouldn’t exceed 100 characters. +</p></dd> +<dt>[<span id="g_t0012"></span>0012]</dt> +<dd><p>Make sure you don’t have code commented out during +commit. Uncomment them or remove them completely. +</p></dd> +<dt>[<span id="g_t0013"></span>0013]</dt> +<dd><p>Do not add comments following the code, add them to the +top of the code. It makes it harder to read, and lines longer. Here is an example: +</p></dd> +</dl> + +<div class="example"> +<pre class="example"># Good way of commenting. +your code goes here + +your code goes here # Avoid this way of commenting. +</pre></div> +</dd> +</dl> <table class="menu" border="0" cellspacing="0"> -<tr><td align="left" valign="top">• <a href="General-Conventions.html" accesskey="1">General Conventions</a></td><td> </td><td align="left" valign="top"> -</td></tr> -<tr><td align="left" valign="top">• <a href="Shell-Conventions.html" accesskey="2">Shell Conventions</a></td><td> </td><td align="left" valign="top"> +<tr><td align="left" valign="top">• <a href="Shell-Conventions.html" accesskey="1">Shell Conventions</a></td><td> </td><td align="left" valign="top">Conventions for shell scripts </td></tr> -<tr><td align="left" valign="top">• <a href="Repository-Conventions.html" accesskey="3">Repository Conventions</a></td><td> </td><td align="left" valign="top"> +<tr><td align="left" valign="top">• <a href="Repository-Conventions.html" accesskey="2">Repository Conventions</a></td><td> </td><td align="left" valign="top">Conventions for repository build scripts </td></tr> </table> - - </body> </html> |