diff options
| author | Sean Whitton <spwhitton@spwhitton.name> | 2022-03-10 18:55:56 -0700 |
|---|---|---|
| committer | Sean Whitton <spwhitton@spwhitton.name> | 2022-03-10 18:55:56 -0700 |
| commit | 2ad18d112c2b028dd5721fe67b98d8f86183c09c (patch) | |
| tree | 9c39ba658a478100d1c34b38486b119162033f1a /CONTRIBUTING.rst | |
| parent | 6d1d7ea0bbd0ef970e22f4c87775f95fb3b8452b (diff) | |
| download | consfigurator-2ad18d112c2b028dd5721fe67b98d8f86183c09c.tar.gz | |
code style: use SETQ over SETF & two text formatting requirements
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 f9a888d..27d7ed4 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -66,6 +66,15 @@ Code style - Choose judiciously between a functional programming style and LOOP. Err on the side of LOOP. +- Use SETQ not SETF whenever SETQ works. + +- Separate sentences with two spaces after the period. In recent Emacs there + is ``M-x repunctuate-sentences`` to help with this. + +- In docstrings, comments and commit messages, refer to symbols and Lisp + packages -- though not ASDF systems -- in BLOCK CAPITALS, without any + quotation marks. + - Avoid complicating property definitions to include updates to file ownership, and the like, when it's possible instead to switch to the target user and apply a simpler version of the property. For example, instead of |