Contribution Guidelines

Ways to contribute

If you have enjoyed using this library and would like to help support it, there are several ways you can help contribute.

• Help answer questions on issues or the gitter chat room. We all start learning at different places. If you see a question you can answer feel to respond. Remember to be kind and respectful. We all start learning at different levels.
• Help improve bug reports
• Improve the documentation (Wiki)
• Submit code changes

Pull Requests

Please take time to read the contributing guidelines before submitting PRs.

Good First Issue

Issues that are tagged with "good first issue" are expected to have good reproduction steps and clear guidelines around what work is needed to complete them. If you are interested in helping out with this library these are great issues to start with. Simply leave a comment on the issue indicating that you are working on it. If you end up not being able to complete the work, please leave another comment so others know that the issue is available to be worked on. Questions on these issues will be given priority, so if you are having any problems completing the work, please ask.

Up-for-grabs Issue

Issues that are tagged with up-for-grabs are available for anyone to work on. Simply leave a comment on the issue indicating that you are working on it to avoid doing duplicate work. If you decide not to complete it, please leave another comment so other people know it is available to be worked on.

Wiki

If you come accross an issue in the Wiki, or you simply want to contribute content please feel free to make any needed changes directly. A pull request and approval process are not necessary. If you would like to discuss potential changes this can be done in the gitter channel.

Improving bug reports

When a new issue is filed it often takes time simply to verify the bug before a fix can be done. This process gets more difficult if the bug report is incomplete. Things you can to to help in this area. A perfect bug report contains:

• Version
• Good steps to reproduce the issue. Preferably a small sample project that demonstrates the issue.
• A description of the observed failure.
• A description of the expected results.

Things people can do to help with triaging issues

• Verify the issue contains the above information. If you are able to, either add the information in a comment or ask the original poster to do so.
• Attempt to reproduce to the bug. If you are able to reproduce the issue please leave a comment indicating that you were also able to reproduce the bug along with the version of the library that you used.
• If the original issue did not contain a reproduction solution consider adding one.