Contributing

Workflow

Create your branch from main
Run mix deps.get to setup the development environment
Make the changes you want and write tests when possible
Ensure all tests passed with mix test
Add all necessary information and examples in your pull request

Commit message convention

We follow conventional commits convention ✨

The commit contains the following structural elements, to communicate intent to the consumers of your library:

fix: patches a bug in your codebase
feat: introduces a new feature to the codebase
BREAKING CHANGE: introduces a breaking API change
refactor: introduce code refactor
docs: changes into documentation
test: adding or updating tests
chore: tooling changes, chore changes

Reporting issues

You can report issues on our github project 🐛