diff options
| author | cbdev <cb@cbcdn.com> | 2020-03-28 23:32:39 +0100 |
|---|---|---|
| committer | cbdev <cb@cbcdn.com> | 2020-03-28 23:32:39 +0100 |
| commit | 126d9945eb3f4289975198b7437defb8bb13be73 (patch) | |
| tree | d590c1d5c1eb3773c23d04b92eb40779e92aa093 | |
| parent | 144e77a2212b2d2f0e3bd689fd7dc231d86a07a6 (diff) | |
| download | midimonster-126d9945eb3f4289975198b7437defb8bb13be73.tar.gz midimonster-126d9945eb3f4289975198b7437defb8bb13be73.tar.bz2 midimonster-126d9945eb3f4289975198b7437defb8bb13be73.zip | |
Extend development guidelines
| -rw-r--r-- | DEVELOPMENT.md | 8 |
1 files changed, 7 insertions, 1 deletions
diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md index 0e677eb..90c63ce 100644 --- a/DEVELOPMENT.md +++ b/DEVELOPMENT.md @@ -13,9 +13,12 @@ in spirit rather than by the letter. * Change in functionality or behaviour requires a change in documentation. * There is more honor in deleting code than there is in adding code. + * Corollary: Code is a liability, not an asset. + * But: Benchmark the naive implementation before optimizing prematurely. * The `master` branch must build successfully. Test breaking changes in a branch. * Commit messages should be in the imperative voice ("When applied, this commit will: "). * The working language for this repository is english. +* External dependencies are only acceptable when necessary and available from package repositories. ### Code style @@ -29,11 +32,14 @@ in spirit rather than by the letter. * The name length should be (positively) correlated with usage * Loop counters may be one-character letters * Prefer to name unsigned loop counters `u` and signed ones `i` +* Place comments above the section they are commenting on + * Use inline comments sparingly #### C specific * Prefer lazy designated initializers to `memset()` -* Avoid `atoi`/`itoa`, use `strto[u]l[l]()` and `snprintf()` +* Avoid `atoi()`/`itoa()`, use `strto[u]l[l]()` and `snprintf()` +* Avoid unsafe functions without explicit bounds parameters (eg. `strcat()`). ## Architecture |