diff options
Diffstat (limited to 'src/docs/Contribution-Guidelines.html')
| -rw-r--r-- | src/docs/Contribution-Guidelines.html | 59 |
1 files changed, 5 insertions, 54 deletions
diff --git a/src/docs/Contribution-Guidelines.html b/src/docs/Contribution-Guidelines.html index c47cd34..0e3bff2 100644 --- a/src/docs/Contribution-Guidelines.html +++ b/src/docs/Contribution-Guidelines.html @@ -15,7 +15,7 @@ Licensed under Gnu Free Documentation License. --> <meta name="Generator" content="makeinfo"> <link href="index.html" rel="start" title="Top"> <link href="index.html" rel="up" title="Top"> -<link href="Init-System.html" rel="next" title="Init System"> +<link href="Conventions.html" rel="next" title="Conventions"> <link href="Setting-up-an-rsync-repository-for-distribution.html" rel="prev" title="Setting up an rsync repository for distribution"> <style type="text/css"> <!-- @@ -51,60 +51,11 @@ Next: <a href="Init-System.html" accesskey="n" rel="next">Init System</a>, Previ throughout the repositories, one must adhere to these guidelines. Exceptions and changes may occur with good reasoning. </p> -<span id="General-Conventions-_002d_002d-GN"></span><h3 class="section">3.1 General Conventions – GN</h3> +<table class="menu" border="0" cellspacing="0"> +<tr><td align="left" valign="top">• <a href="Conventions.html" accesskey="1">General Conventions – 00</a></td><td> </td><td align="left" valign="top"> +</td></tr> +</table> -<p>These apply to each and every file on the repositories. -</p> -<ul> -<li> Try to keep the file readable. [<span id="GN0010"></span>GN0010] -<ul> -<li> Characters on a line shouldn’t exceed 100 characters excluding indentation. [<span id="GN0011"></span>GN0011] -</li><li> Make sure you don’t have code commented out during commit. Uncomment them -or remove them completely. [<span id="GN0012"></span>GN0012] -</li><li> Do not add comments following the code, add them to the top of the code. It -makes it harder to read, and lines longer. [<span id="GN0013"></span>GN0013] -Here is an example: -<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> -</li></ul> -</li></ul> - -<span id="Shell-conventions-_002d_002d-SH"></span><h3 class="section">3.2 Shell conventions – SH</h3> - -<p>Shell is central to Carbs Linux projects. Most of the tools and packages are -written in POSIX sh. -</p> -<ul> -<li> Use 4 spaces for indentation, instead of tabs. [<span id="SH0010"></span>SH0010] -</li><li> Make sure you don’t use bash-specific code. [<span id="SH0020"></span>SH0020] -</li><li> Make sure you lint your code with <code>shellcheck</code> and if you are new to -POSIX sh, use <code>checkbashisms</code>. [<span id="SH0030"></span>SH0030] -</li><li> Don’t spawn new processes if you don’t absolutely need to, especially during -string manipulation. [<span id="SH0040"></span>SH0040] -<ul> -<li> Never use a program for text manupilation that isn’t defined in the POSIX -standard. This includes <code>gawk</code> and <code>perl</code>. [<span id="SH0041"></span>SH0041] -</li><li> Instead of <code>$(basename $file)</code>, use <code>${file##*}</code>. [<span id="SH0042"></span>SH0042] -</li><li> Instead of <code>$(dirname $file)</code>, use <code>${file%/*}</code>. [<span id="SH0043"></span>SH0043] -</li></ul> -<div class="example"> -<pre class="example"># This is the same thing as <code>basename /path/to/test.asc .asc</code> - -$ file=/path/to/test.asc file=${file##*/} file=${file%.asc} -$ echo $file -test -</pre></div> -</li><li> Instead of backticks, use <tt>$(..)</tt>. [<span id="SH0050"></span>SH0050] -</li></ul> -<hr> -<div class="header"> -<p> -Next: <a href="Init-System.html" accesskey="n" rel="next">Init System</a>, Previous: <a href="Package-Manager.html" accesskey="p" rel="prev">Package Manager</a>, Up: <a href="index.html" accesskey="u" rel="up">Top</a> </p> -</div> |