CONTRIBUTING.org

Style guide

Use Ormolu

Use Ormolu to format code.

Use complete sentences

Wherever possible, use complete sentences ended by full stops. This includes error messages, warnings, and comments. Headline, list items or mathematical objects may be excluded. For example,

- A
- B
- C

or,

Length: 10.13

Total functions

If possible, use total functions. In particular, avoid using error. Functions that are pure but non-total should be called functionNameUnsafe.

Design principles

Files and standard input

Binaries should accept input files, and not the standard input, because ELynx is designed for reproducible runs.