You can contribute to this project by doing any of the following:
- Reporting bugs and features in the issue tracker.
- Submitting and reviewing pull requests
- Helping with documentation
- Helping with testing
GitHub supports markdown, so when filing bugs, make sure you check the formatting before you submit.
Before submitting a feature or substantial code contribution, please discuss it with the team and ensure that it follows the product roadmap.
You might also read these two blogs posts about contributing code:
- Open Source Contribution Etiquette by Miguel de Icaza.
- Don't "Push" Your Pull Requests by Ilya Grigorik.
If you don't know what a pull request is, read the "Using pull requests" article.
Some guidelines for pull requests:
- Use a descriptive title and description.
- Include a single logical change.
- Base your change on master branch - after a request is accepted, it can be ported to stable branches.
- Your change should cleanly merge with the target branch.
- Separate the subject from the body with a blank line.
- Limit the subject line to 50 characters.
- Capitalize the subject line.
- Do not end the subject line with a period.
- Use the imperative mood in the subject line (e.g. Fix #123: Make pigs fly).
- Wrap the body at 72 characters.
- Use the body to explain what and why. The how should be mostly covered by the diff.