Contribution Guidelines

Thanks for contributing!

Style

Commit messages

Commit messages must adhere to the seven rules of commit messages. In short:

  1. Separate subject from body with a blank line
  2. Limit the subject line to 50 characters
  3. Capitalize the subject line
  4. Do not end the subject line with a period
  5. Use the imperative mood in the subject line
  6. Wrap the body at 72 characters
  7. Use the body to explain what and why vs. how

Pug

We use pug-lint with its default settings to lint pug files.

CSS

We use stylelint to lint CSS. Check .stylelintrc.yml.

Javascript

We use eslint to lint JS. Check .eslintrc.yml and .eleventyignore.

General

We use EditorConfig to standardise line endings etc. Check .editorconfig.