Skip to content

Latest commit

 

History

History
51 lines (35 loc) · 1.47 KB

CONTRIBUTING.md

File metadata and controls

51 lines (35 loc) · 1.47 KB

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:

# sh
# in the project root, run:
ln -sf ../../.scripts/pre-commit .git/hooks/pre-commit
ln -sf ../../.scripts/post-commit .git/hooks/post-commit

# Yeah you read that right! Two folders up is necessary.
# See: https://stackoverflow.com/questions/4592838/symbolic-link-to-a-hook-in-git#4594681

Note that our 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).

Our commit messages (at least on develop) are formatted as described here.

Please set up our super nice commit message template to supercharge ⚡⚡ your commit messages!

# sh
# in the project root, run:

git config commit.template .git_commit_msg.txt

To make this your commit template globally, just add the --global flag!

Have fun commiting new changes! 🌈