diff options
Diffstat (limited to 'contribution.texi')
| -rw-r--r-- | contribution.texi | 31 |
1 files changed, 16 insertions, 15 deletions
diff --git a/contribution.texi b/contribution.texi index a34291e..9a6baca 100644 --- a/contribution.texi +++ b/contribution.texi @@ -1,5 +1,5 @@ @macro contid{id} -[@anchor{\id\}\id\] +@strong{[@anchor{\id\}\id\]} @end macro @node Contribution Guidelines @@ -9,22 +9,23 @@ Thanks for taking your time to contribute! To maintain stylistic behaviour throughout the repositories, one must adhere to these guidelines. Exceptions and changes may occur with good reasoning. -@section General Conventions -- GN +@node Conventions +@section General Conventions -- 00 These apply to each and every file on the repositories. @itemize @item -Try to keep the file readable. @contid{GN0010} +Try to keep the file readable. @contid{0010} @itemize @item -Characters on a line shouldn't exceed 100 characters excluding indentation. @contid{GN0011} +Characters on a line shouldn't exceed 100 characters excluding indentation. @contid{0011} @item Make sure you don't have code commented out during commit. Uncomment them -or remove them completely. @contid{GN0012} +or remove them completely. @contid{0012} @item Do not add comments following the code, add them to the top of the code. It -makes it harder to read, and lines longer. @contid{GN0013} +makes it harder to read, and lines longer. @contid{0013} Here is an example: @example # Good way of commenting. @@ -35,30 +36,30 @@ your code goes here # Avoid this way of commenting. @end itemize @end itemize -@section Shell conventions -- SH +@section Shell Conventions -- 10 Shell is central to Carbs Linux projects. Most of the tools and packages are written in POSIX sh. @itemize @item -Use 4 spaces for indentation, instead of tabs. @contid{SH0010} +Use 4 spaces for indentation, instead of tabs. @contid{1010} @item -Make sure you don't use bash-specific code. @contid{SH0020} +Make sure you don't use bash-specific code. @contid{1020} @item Make sure you lint your code with @command{shellcheck} and if you are new to -POSIX sh, use @command{checkbashisms}. @contid{SH0030} +POSIX sh, use @command{checkbashisms}. @contid{1030} @item Don't spawn new processes if you don't absolutely need to, especially during -string manipulation. @contid{SH0040} +string manipulation. @contid{1040} @itemize @item Never use a program for text manupilation that isn't defined in the POSIX -standard. This includes @command{gawk} and @command{perl}. @contid{SH0041} +standard. This includes @command{gawk} and @command{perl}. @contid{1041} @item -Instead of @code{$(basename $file)}, use @code{$@{file##*@}}. @contid{SH0042} +Instead of @code{$(basename $file)}, use @code{$@{file##*@}}. @contid{1042} @item -Instead of @code{$(dirname $file)}, use @code{$@{file%/*@}}. @contid{SH0043} +Instead of @code{$(dirname $file)}, use @code{$@{file%/*@}}. @contid{1043} @end itemize @example # This is the same thing as @code{basename /path/to/test.asc .asc} @@ -68,5 +69,5 @@ $ echo $file test @end example @item -Instead of backticks, use @verb{|$(..)|}. @contid{SH0050} +Instead of backticks, use @verb{|$(..)|}. @contid{1050} @end itemize |