changelog shortlog graph tags branches changeset files revisions annotate raw help

Mercurial > org > docs / style.org

changeset 3: bd85a72319d8
parent: 087da4ed0df6
child: bb51c61e4d4b
author: ellis <ellis@rwest.io>
date: Sun, 05 Nov 2023 22:46:15 -0500
permissions: -rw-r--r--
description: migrated nas-t docs
1 #+TITLE: style
2 
3 As an organization we maintain a styleguide[fn:1] which lists all of
4 the style guidelines we use for our code. If you are contributing to
5 one of our projects, you should review and understand the relevant
6 sections below.
7 
8 You should also review the [[file:ulang.org][ulang]] document, which may shine some light
9 on code comments and developer docs.
10 
11 [fn:1] https://google.github.io/styleguide/
12 
13 * General Programming
14 
15 - indent-offset = 2
16 - max-line-width = 80
17 - page-length ~ 32
18 - module-length ~ 512
19 - file-size ~ 1024
20 
21 - start every source-file with a header comment
22 - use outline headings to organize your program
23 - use ulang-comments as needed for referencing bugs, notes, etc.
24 - inline documentation should be declarative. your code explains your
25  comments for you.
26 
27 * Common Lisp
28 
29 - prefer symbol docs to comment docs
30 
31 ** File templates
32 * Rust
33 
34 - don't make =mod.rs= files
35  - use the =foo.rs=, =foo/*= pattern instead
36 ** File templates
37 * Emacs Lisp
38 ** File templates
39 * Org-mode
40 ** File templates
41 * Shell
42 ** File templates
43 * Python
44 ** File templates