Skip to content

Latest commit

 

History

History
31 lines (22 loc) · 898 Bytes

CONTRIBUTING.md

File metadata and controls

31 lines (22 loc) · 898 Bytes
Raw

Contributing

Set up git hooks

The repo includes some handy git hooks under .scripts/:

  • pre-commit Runs the format --check-formatted task.
  • post-commit Runs a customised credo check.

We strongly recommend that you set up these git hooks on your machine by:

# in the project root!
ln -sf ../../.scripts/pre-commit .git/hooks/pre-commit
ln -sf ../../.scripts/post-commit .git/hooks/post-commit

Note that the CI will fail your PR if you dont run mix format in the project root.

Styling

We follow lexmag/elixir-style-guide and rrrene/elixir-style-guide (both overlap a lot).

PR submission checklist

  • git hooks had been set up before development.
  • You ran mix dialyzer and no new warnings were emitted (especially due to your changes).