Thanks a lot for any contribution!
To keep code quality high and maintenance work low, please adhere to the following guidelines when creating a pull request:
- Please follow the coding guidelines.
- Use meaningful commit messages: Please follow the advice in this blogpost. First line of your commit message should be a very short summary (ideally 50 characters or less) in the imperative mood. After the first line of the commit message, add a blank line and then a more detailed explanation (when relevant).
The following items make my life easier, but are optional:
-
If you know how to use
git rebase
, please rebase/sqash your commits so that unnecessary noise in the commit history is avoided. -
If you have have previously filed a GitHub issue and want to contribute code that addresses that issue, I prefer it if you use hub to convert your existing issue to a pull request. To do that, first push the changes to a separate branch in your fork and then issue the following command:
hub pull-request -b dbrgn:master -i <issue-number> -h <your-github-username>:<your-branch-name>
This is no strict requirement though, if you don't have hub installed or prefer to use the web interface, then feel free to post a traditional pull request.
Thanks for your contribution!