We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
- Reporting a bug
- Discussing the current state of the code
- Submitting a fix
- Proposing new features
Follow the instructions in the page below to set up the project on your local environment
Add a comment on the issue and wait for the issue to be assigned before you start working on it. This helps to avoid multiple people working on similar issues.
We actively welcome your pull requests, below is the process to add a change:
1- Create an issue where you explain clearly the problem you want to solve
2- Fork the repo and create your branch from main. Please create the branch in the format /feat/ (eg: eric/feat/add-new-auth-method)
3- If the code you added require a test, write them
4- Ensure the test suite passes.
5- Ensure the code lint succeed
6- Make a Pull Request
When you submit code changes, your submissions are understood to be under the same MIT License that covers the project.
Report bugs using GitHub's issues
We use GitHub issues to track public bugs. Report a bug by opening a new issue. It's that easy!
Great Bug Reports tend to have:
- A quick summary and/or background
- Steps to reproduce
- Be specific!
- Give sample code if you can.
- What you expected would happen
- What actually happens
- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
By contributing, you agree that your contributions will be licensed under its AGPL v3 License.
Send a mail at [email protected].