If you have a patch or pull request for us, thank you!
The more of these guidelines you can follow, the easier (and faster) it is for us to evaluate your code and incorporate it into the development branch.
(Borrowing from ThinkUp's Pull Request Checklist):
- Make sure you can perform a full build and that the tests all pass. (See Building and Testing)
- Please add unit tests to demonstrate that your submission fixes an existing bug, or performs as intended.
- Rebase your branch on the current state of the
masterbranch. Usegit rebase master. This means you might have to deal with conflicts. - Be descriptive in your commit messages: explain the purpose of all changes.
You can modify commit messages by doing
git commit --amend(for the previous change), orgit rebase -ifor earlier changes.
Once your branch is cleaned up, please submit the Pull request against the master branch.
Thanks for your help!
A typical workflow:
# get up to date with origin/master and create a branch
git checkout master
git pull
git checkout -b newbranch
# now make your commits.
$EDITOR somefile
git commit -m "my change"
# If you are now out of date with master, update your master:
git checkout master && git pull
# now go back to your branch and rebase on top of master
git checkout - # "-" will checkout previous branch
git rebase master
# resolve any conflicts, and possibly do `git rebase --continue` to finish rebasing
# now push your branch to your fork, and submit a pull request
git push myfork newbranch