How to do PRs

The Developer Guide provides the broad picture. This page provides more detailed guidance on development with git and GitHub. In particular, it provides guidance on how to set up a pull request (PR) that is easy to manage.

Working with your own fork

If you use your own fork to create the PRs read GitHub's documentation on Working with Forks.

The most important points: Add the alchemistry.org main repos ("upstream") as git remotes. E.g., for alchemistry/alchemlyb:

git remote add upstream git@github.com:alchemistry/alchemlyb.git

Sync your own checked out copy with the upstream

git checkout master     # make sure you're on master
git pull upstream master

PRs get their own branches

Create a new branch for each PR. The workflow should be:

git checkout master
git pull      # update from GitHub
git checkout -b issue-NNN-SUMMARY
# hack on code
git add ...
git commit ...
# hack more...
# ...
# push to a branch 
git push -u origin issue-NNN-SUMMARY
# use GitHub to create a PR from the branch

For more details read GitHub's

• Creating a pull request (if you are working directly on the alchemistry repository)
• Creating a pull request from a fork