View Source Contributing

Thank you for contributing to the project. We'd love to see your issues and pull requests.

If you're creating a pull request, please consider these suggestions:

Fork, then clone the repo:

git clone

Install the dependencies:

mix deps.get

Make sure the tests pass:

mix test

Make your change. Add tests for your change. Make the tests pass:

mix test

Push to your fork (preferably to a non-master branch) and submit a pull request.

We'll review and answer your pull request as soon as possible. We may suggest some changes, improvements, or alternatives. Let's work through it together.

Some things that will increase the chance that your pull request is accepted:

  • Write tests.
  • Include @typedocs, @specs, and @docs
  • Try to match the style conventions already present (and Elixir conventions, generally).
  • Write a good commit message.

Thanks again for helping!