Skip to content

Latest commit

 

History

History
28 lines (17 loc) · 830 Bytes

CONTRIBUTING.md

File metadata and controls

28 lines (17 loc) · 830 Bytes

Contributing to Feldspar

Start by reading tibbe's style guide. Current Feldspar follows most of the conventions except for the section on data types.

Use your judgement. Having a line that is 83 characters long might be a better choice compared to the alternative even if it violates the style guide.

  1. No commits to master in your fork.

  2. Follow whatever code style the file uses. One consistent but bad style is preferable over having eight different good styles in the same file.

  3. No trailing whitespace.

  4. Run cabal test before committing.

  5. Use one commit per logical change.

  6. Keep the pile of small style fixes and similar in one or several separate commits.

  7. Make a sensible commit message.