Thank you for taking the time to help us make this project better!
We’re thrilled that you’d like to contribute and we’d love for you to get involved. Whatever your level of skill or however much time you can give, your contribution is greatly appreciated.
There are many ways to contribute, from writing tutorials or blog posts, improving the documentation, submitting bug reports and feature requests, helping other users by commenting on issues, or writing code which can be incorporated into our project.
Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue, assessing changes, and helping you finalize your pull requests.
We’d love to help. Check out the support guidelines.
Here are a few tips for writing great bug reports:
If you find a security vulnerability, do not open an issue. Please check our security policy for instructions.
If you find yourself wishing for a feature that doesn’t exist in this project, you are probably not alone. There are bound to be others out there with similar needs.
Feature requests are welcome. But take a moment to find out whether your idea fits with the scope and goals of the project. It’s up to you to make a strong case to convince the project’s developers of the merits of this feature. Please provide as much detail and context as possible, including describing the problem you’re trying to solve.
Open an issue which describes the feature you would like to see, why you want it, how it should work, etc.
We’d love for you to contribute to the project. Unsure where to begin contributing? You can start by looking through these “good first issue” and “help wanted” issues:
PS: Feel free to ask for help! :smiley_cat:
Here’s a few general guidelines for proposing changes:
At a high level, the process for proposing changes is:
git checkout -b my-branch-name
Interesting in submitting your first Pull Request? It’s easy! You can learn how from this free series How to Contribute to an Open Source Project on GitHub
This project is governed by the Contributor Covenant Code of Conduct. By participating, you are expected to uphold this code.