Creating a pull request on GitHub

Submitting a pull request means that you’re asking for on your own fork of PsychoPy® to be “pulled in” to the main code - essentially, taking all of the changes on that fork and applying them. To open a pull request…

  1. Go to the |PsychoPy| repository on GitHub

  2. Open the “Pull Requests” tab

  3. Click “New pull request”

  4. Click the link near the top which says “compare across forks”

  5. On the left, choose the branch of psychopy/psychopy which you’d like to pull into; click here for more information on what the branches mean

  6. On the right, choose the branch of your fork which you’d like to merge into the main code .. warning:

    Make sure your branch was based off of the branch you're pulling into - so that you don't accidentally pull the entirety of one branch into another!

  7. Check that the commits and changes shown below are the ones you’re intending to make, then click “Create pull request”

  8. Give your pull request a name - this will appear in the release notes, so try to make it informative and concise, but still understandable to a novice user .. note:

    Adding a prefix to your pull request title in line with our :ref:`commit conventions <_commitMessages>` makes it easier for to sort pull requests when writing the release notes

  9. Write any additional details you want to give in the pull request description and click “Create pull request”

…and you’re done! The developers will review your pull request and either accept, or give you some feedback on what you need to do for your changes to be pulled in. It’s very normal for pull requests to need a few tweaks before being pulled in, so please don’t be disheartened if it isn’t accepted right away!


Back to top