diff options
| author | Sean Whitton <spwhitton@spwhitton.name> | 2021-05-06 12:58:56 -0700 |
|---|---|---|
| committer | Sean Whitton <spwhitton@spwhitton.name> | 2021-05-06 12:58:56 -0700 |
| commit | 4ed2a639d8e085d54ddedcb73d93e28754aa239b (patch) | |
| tree | aee7b26de923366ec7012c23398c3b823ce16cbe /CONTRIBUTING.rst | |
| parent | b889760a1527207a409d89aeb84b684cc85d7be0 (diff) | |
| download | consfigurator-4ed2a639d8e085d54ddedcb73d93e28754aa239b.tar.gz | |
start a "Code style" section in CONTRIBUTING.rst
Signed-off-by: Sean Whitton <spwhitton@spwhitton.name>
Diffstat (limited to 'CONTRIBUTING.rst')
| -rw-r--r-- | CONTRIBUTING.rst | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 0b3f0b9..160f86c 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -57,6 +57,15 @@ Please read "How to Report Bugs Effectively" to ensure your bug report constitutes a useful contribution to the project: <https://www.chiark.greenend.org.uk/~sgtatham/bugs.html> +Code style +========== + +- Stick to a line width of 78. An exception is made for string literals like + error messages. + +- Choose judiciously between a functional programming style and LOOP. Err on + the side of LOOP. + Signing off your commits ======================== |