CONTRIBUTING

October 3, 2023 ยท View on GitHub

Contributions are welcome, and are accepted via pull requests. Please review these guidelines before submitting any pull requests.

Process

  1. Fork the project
  2. Create a new branch
  3. Code, test, commit and push
  4. Open a pull request detailing your changes. Make sure your PR title follows Conventional Commits.

Guidelines

  • Please ensure the coding format by running mix format.
  • You may need to rebase to avoid merge conflicts.
  • Please remember that we follow SemVer.

Setup

Clone your fork, then install the dependencies:

mix deps.get

Format

Format your code:

mix format

Lint

Lint your code with credo and dialyxir:

mix credo
mix dialyzer

Tests

Run all tests:

mix test

Releasing

The release process of this repository is automated as much as possible to ensure there isn't a bottle neck, or merged PRs waiting to be deployed. Once a PR is merged it into main, a secondary PR will be created or updated with a title like so: chore(main): release <version>. This PR will include all of the needed changes for a new release, including an updated CHANGELOG.md file, increasing the version in mix.exs, and updating any documentation. Once a maintainer merged that PR in, a new release will be created in GitHub and pushed to hex.pm.