Skip to content

Latest commit

 

History

History
78 lines (51 loc) · 2.59 KB

File metadata and controls

78 lines (51 loc) · 2.59 KB

Contributing

🚓 Code of Conduct

This project and everyone participating in it is govened by the Code of Conduct. By participating, you are required to uphold this code and any unacceptible behaviour will not be tollerated.

⚖️ Licence

Whenever you add content to a repository, you license that content under the same terms, and you agree that you have the right to license that content under those terms.

✍️ Contribution

Support

Please ask any questions in the repositories discussions board.

Bug Reports

Is something not behaving as expeceted or documented? Please let us know by opening an issue.

Before creating a new issue, make sure to search the github issues for an existing report, adding a 👍 emoji to an existing report will help us prioritise.

Feature Requests

Are we missing a feature, or could an existing one be improved? Feel free to file a feature request in the respository issues.

Before creating a new issue, make sure to search the github issues for an existing report, adding a 👍 emoji to an existing report will help us prioritise.

Documentation issue

Does something in our docs not make sense? or are they misleading or just plain wrong? please let us know by creating an issue.

Before creating a new issue, make sure to search the github issues for an existing report, adding a 👍 emoji to an existing report will help us prioritise.

Pull Requests

The fastest way to get a changes made is to contribute a pull request, when doing so, please open a feature request or file a bug report in the issues first where we can discuss the problem and possible soultions.

Feel free to open a draft pull request early in the process and we can help with any of the following steps.

A single pull requests should contain either a single feature, or wide spread corrections too formatting/whitespace/etc, not both.

Code contributions need to be accompanied by tests and documentation for the added code.

Make sure that you run the code formatter and that our linting checks and tests all pass.

We would appreciate it if you formatted your commit messages according to the conventional commits standard, but we can also fix things up when merging the pull request, so dont worry too much if it doesnt make sense to you.

Sponsorship

These projects are maintained on a volenteer basis, sponsorship can help make spending more time on a open sorce work financially viable.