The perfect pull request

If you’ve got bug fixes for Mephisto, I’m interested in pulling them into my tree. You can just send me a pointer to a patch, and I’ll take a look.

But if you want to make your branch super-easy to merge, here are some suggestions:

1. Make sure that your patches have good descriptions. What’s the bug? Why is your patch the correct fix?
2. Make sure that your branch contains only bug fixes, and not (for example) your site’s database.yml.
3. If possible, base your branch on a recent release of Mephisto (or my master branch).
4. Please run ‘rake’ and make sure that all unit tests pass.

To create a patch branch, you can run:

git remote add emk git://github.com/emk/mephisto.git 
git fetch emk
git checkout -b for-pull emk/master
git config branch.for-pull.remote origin
git config branch.for-pull.merge refs/heads/for-pull

Then, for each patch you want to add, cherry pick it and make sure the description explains the original bug and how you fixed it:

git cherry-pick --edit fd4323...
rake
# If you have any unit test failures, fix them and run:
git commit -a --amend

Here are some notes on formatting [Git commit messages][git].

Once all your patches are done, push them to your git repo:

# You might need slightly different arguments the first time. Please feel free to fix the wiki.
# git push --all worked for me
git push

Then, submit a pull request to emk and I’ll take a look. Many thanks for your contributions to Mephisto!