From opening a bug report to issuing a pull request, every contribution is much appreciated and welcomed. If you are planning to implement a new feature or make changes to certain api, please first create an issue. In that case, we can ensure that your precious work does not left unnoticed.
Code of Conduct
Please read and follow our Code of Conduct.
Questions and Problems
We try to keep our GitHub issues for bug reports and feature requests only. If you have a general support question, please instead try Stack Overflow Our team are actively answering questions there. Or you might find your question already being answered.
Issues and Bugs
Check our Road Map and see if we have already planned for the feature.
If you would like to implement a new feature then consider what kind of change it is:
- Major Changes: the changes should first be discussed in a GitHub Issue that clearly outlines the changes and benefits of the feature.
- Small Changes: you can directly submit it to the GitHub Repository as a Pull Request. Please see the section about Pull Request Submission Guidelines, and for detailed information, the core development document.
Pull Request Submission Guidelines
Before you submit your pull request, first consider the following guideline:
- Search GitHub for an open or closed Pull Request that relates to your submission. You don't want to duplicate effort.
- Create the development environment
- Make your change in a new git branch:
git checkout -b my-fix-branch master
- Create your patch commit, including appropriate test cases.
- If the changes affect public APIs, change or add relevant documentation
- Run tests, and ensure that all tests pass.
- Commit your changes using a descriptive commit message that follows our commit message conventions. Adherence to our conventions are required, because release notes are automattically generated from these messages.