Pull requests are greatly appreciated and are what makes opensource great. Here's a quick guide:
- Fork it
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin my-new-feature) - Create new Pull Request
Pester us if we don't get your Pull Requests merged in a timely fashion. :)
- Describe your changes in the CHANGELOG.
- Give yourself some credit in the appropriate place (usually the CHANGELOG).
- Make commits of logical units.
- Ensure your commit messages help others understand what you are doing and why.
- Check for unnecessary whitespace with
git diff --checkbefore committing. - Maintain the same code style.
- Maintain the same level of test coverage or improve it.
Simple house-keeping for clean git history.
Read more on How to Write a Git Commit Message or the Discussion section of git-commit(1).
- Separate the subject from 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
- Wrap the body at 72 characters
- Use the body to explain what and why vs. how
- If there was important/useful/essential conversation or information, copy or include a reference
- When possible, one keyword to scope the change in the subject (i.e. "README: ...", "runtime: ...")
- Always refer to the ticket(s) it solves and to any other relevant tickets, articles or other resources