Hi there! If you're looking to contribute, you're in the right place :) also, thank you in advance!
By contributing to this repository, you are expected to know and follow the rules of laid out in our Code of Conduct.
Working on your first Pull Request? How to Contribute to an Open Source Project on GitHub
-
Project setup? We've got you covered!
-
Found a bug? Report it so we can start working on a fix!
-
Want a new feature? Shweeet, lay it out for us!
-
Patched a bug? Make a PR!
- Fork and clone the repo
- [Install Erlang/OTP & Elixir][Installing Erlang/OTP & Elixir]
- Install project dependencies with
mix deps.install - Create a branch for your PR
This project is built with Erlang/OTP & Elixir, the specific versions for these languages are outlined in .tool-versions.
We use asdf for managing our language versions. To setup asdf, please follow their getting started.
With asdf installed, run asdf install from the project root.
Note: This is just our recommended way to install Erlang/OTP & Elixir, feel free to go your own way. The official Elixir Install Guide lists a number of different ways to install Elixir
Commits should be as small as possible, with exceptions for large sweeping changes required by lint rule changes, package updates, etc. Commit messages should be clear, as we additionally recommend (but don't require) that commits include descriptions describing: why the change is necessary, any forseen issues, and paths intentionally not taken (and why).