{{{header(style,

 Richard Westhaver,

 ellis@rwest.io,

 The Compiler Company Styleguide)}}}

 As an organization we maintain a styleguide[fn:1] which lists all of

 the style guidelines we use for our code. If you are contributing to

 one of our projects, you should review and understand the relevant

 sections below.

 You should also review the [[file:ulang.org][ulang]] document, which may shine some light

 on code comments and developer docs.

 [fn:1] https://google.github.io/styleguide/ 

 * General Programming

 - indent-offset = 2

 - max-line-width = 80

 - page-length ~ 32

 - module-length ~ 512

 - file-size ~ 1024

 - start every source-file with a header comment

 - use outline headings to organize your program

 - use ulang-comments as needed for referencing bugs, notes, etc.

 - inline documentation should be declarative. your code explains your

   comments for you.

 - variables, imports, and exports belong at the top of a file

 - =main= functions belong at the bottom of a file

 * Common Lisp

 - prefer symbol docs to comments

 - use stdin/stdout/stderr correctly - see [[https://zenodo.org/records/3414191][CDR-11]]

 - always prefer =core= libraries over vendored dependencies

 - use the compiler internals - if a function or class is generally

   useful, add it to the core

 * Rust

 - don't make =mod.rs= files

   - use the =foo.rs=, =foo/*= pattern instead

 * Emacs Lisp

 * Org-mode

 * Shell

 * Python