Pull requests, bug reports, and all other forms of contribution are welcomed and highly encouraged!
This guide serves to set clear expectations for everyone involved with the project so that we can improve it together while also creating a welcoming space for everyone to participate. Following these guidelines will help ensure a positive experience for contributors and maintainers.
Please review our Code of Conduct. It is in effect at all times. We expect it to be honored by everyone who contributes to this project. We reserve the right to remove participants who exhibit harassing, malicious, or persistently disruptive behaviour.
Please see our Support Guide.
Before creating an issue, check if you are using the latest version of the project. If you are not up-to-date, see if updating fixes your issue first.
Please review our Security Policy. DO NOT file a public issue for security vulnerabilities.
A great way to contribute to the project is to send a detailed issue when you encounter a problem. We always appreciate a well-written, thorough bug report.
Feature requests are welcome! While we will consider all requests, we cannot guarantee your request will be accepted. If accepted, we cannot make any commitments regarding the timeline for implementation and release. However, you are welcome to submit a pull request to help!
- Do not open a duplicate feature request. Search for existing feature requests first. If you find your feature (or one very similar) previously requested, comment on that issue.
- Fully complete the provided issue template. The feature request template asks for all necessary information for us to begin a productive conversation.
- Be precise about the proposed outcome of the feature and how it relates to existing features. Include implementation details if possible.