First of all, thanks for thinking of contributing to this project! 👏
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.
As a contributor, here are the guidelines we would like you to follow:
Table of Contents
- Code of Conduct
- How can I contribute?
- Using the issue tracker
- Submitting a Pull Request
- Style Guides
We also recommend that you read How to Contribute to Open Source.
Please note that this project have a code of conduct, please follow it in all your interactions with the project.
Some issues are created without information requested in the Bug report guideline. Help make them easier to resolve by adding any relevant information.
Issues with the enhancement label are meant to discuss the implementation of new features. Participating in the discussion is a good opportunity to get involved and influence our future direction.
Confirmed bugs and ready-to-implement features are marked with the help wanted label. Post a comment on an issue to indicate you would like to work on it and to request help from the maintainers and the community.
The issue tracker is the channel for bug reports, features requests and submitting pull requests only.
Before opening an issue or a Pull Request, please use the GitHub issue search to make sure the bug or feature request hasn't been already reported or fixed.
A good bug report shouldn't leave others needing to chase you for more information. Please try to be as detailed as possible in your report and fill the information requested in the Bug report template.
Feature requests are welcome, but take a moment to find out whether your idea fits with the scope and aims 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 and fill the information requested in the Feature request template.
Good pull requests, whether patches, improvements, or new features, are a fantastic help. They should remain focused in scope and avoid containing unrelated commits.
Please ask first before embarking on any significant pull requests (e.g. implementing features, refactoring code), otherwise you risk spending a lot of time working on something that the project's developers might not want to merge into the project.
If you have never created a pull request before, welcome 🎉 😄. Here is a great tutorial on how to send one. 😃
This is our preferred process for opening a PR on GitHub:
- Fork this repository
- Create your feature branch (
git checkout -b feature/AmazingFeature) - Commit your changes (
git commit -m 'Add some AmazingFeature') - Push to the branch (
git push origin feature/AmazingFeature) - Open a pull request
To ensure code quality and make sure other people can understand your changes, you have to document your code. For documentation and general code cleanliness, we ask that you follow the appropriate styleguide for the language you're working in.