3.1 Conventions

3.1.1 General Conventions – 00

These apply to each and every file on the repositories.

• Try to keep the file readable. [0010]
  • Characters on a line shouldn’t exceed 100 characters excluding indentation. [0011]
  • Make sure you don’t have code commented out during commit. Uncomment them or remove them completely. [0012]
  • Do not add comments following the code, add them to the top of the code. It makes it harder to read, and lines longer. [0013] Here is an example:

    # Good way of commenting.
    your code goes here
    
    your code goes here  # Avoid this way of commenting.
    

3.1.2 Shell Conventions – 10

Shell is central to Carbs Linux projects. Most of the tools and packages are written in POSIX sh.

• Use 4 spaces for indentation, instead of tabs. [1010]
• Make sure you don’t use bash-specific code. [1020]
• Make sure you lint your code with shellcheck and if you are new to POSIX sh, use checkbashisms. [1030]
• Don’t spawn new processes if you don’t absolutely need to, especially during string manipulation. [1040]
  • Never use a program for text manupilation that isn’t defined in the POSIX standard. This includes gawk and perl. [1041]
  • Instead of $(basename $file), use ${file##*}. [1042]
  • Instead of $(dirname $file), use ${file%/*}. [1043]

  # This is the same thing as basename /path/to/test.asc .asc
  
  $ file=/path/to/test.asc file=${file##*/} file=${file%.asc}
  $ echo $file
  test
  

• Instead of backticks, use $(..). [1050]