diff options
Diffstat (limited to 'HACKING.md')
| -rw-r--r-- | HACKING.md | 16 |
1 files changed, 14 insertions, 2 deletions
@@ -102,7 +102,7 @@ use-case for it). In the shebang, don't pass flags to bash, besides breaking `env` (above), it means people will make mistakes when debugging, and -running things with `bash FILENAME`. Instead, use `set` to adjust the +running things with `bash FILENAME`. Instead, use `set` to adjust the flags inside of the program. Obey `$TMPDIR`. It's usually as easy as passing `--tmpdir` to @@ -212,7 +212,7 @@ the better option, as otherwise you would have to use `seq` (calling an external), or `eval` (gross, easy to mess up royally). Indent comments like you would code; don't leave them at the beginning -of the line. Example: +of the line. Example: for item in "${list[@]}"; do if [[ $item == foo ]]; then @@ -234,3 +234,15 @@ doesn't have to go on the right side of a command: cat file | program # useless use of cat program < file # data flows right to left < file program # just right + +Copyright statements should look like + + # Copyright (C) YEARS NAME <EMAIL> + +for most code, for 3rd-party code that has been imported, indent it a +bit: + + # Copyright (C) YEARS NAME <EMAIL> + +Always put a line with `# License:` specifying the license of that +file. |