Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
Report bugs using our issue tracker.
If you are reporting a bug, please make sure to fill out the appropriate issue template.
Look through the repository issue tracker for bugs. Anything tagged with "bug" and "help wanted" is open to whoever wants to implement it.
Look through the repository issue tracker for features. Anything tagged with "enhancement" and "help wanted" is open to whoever wants to implement it.
Add markdown to the docs folder. See GitHub Markdown.
The best way to send feedback is to file an issue.
If you are proposing a feature:
- Explain in detail how it would work.
- Keep the scope as narrow as possible, to make it easier to implement.
- Remember that this is a volunteer-driven project, and that contributions are welcome :)
Feel free to comment on open prs. Please contact us if you want to become a core team member. Core team members are assigned as reviewers to all prs by default. The review of a core team member is required for prs from non-members of the core team.
Please adhere to the general Clean Code principles. For instance, we write short and concise functions and use appropriate naming to ensure readability.
- Open a pull request on GitHub targeting the
mainbranch. Make sure to fill out the template.
- Principle 1: A review from a core team member is automatically requested. At least one approval is required to merge for non-core team members.
- Principle 2: Formulate your expectations on risk (e.g. low/mid/high) and feedback/discussion (e.g. high: new concept XYZ, minor: refactoring).
- Once successfully reviewed and status checks passed, squash-merge the PR.
This collapses all the commits into one and merges it into the
mainbranch. Please adjust the subject line and body of the commit to accurately reflect your changes and prefix the commit with one of the labels of Conventional Commit messages.
We have GitHub ruleset in place for the main branch enforcing: