Skip to content

Latest commit

 

History

History
47 lines (31 loc) · 2.13 KB

how_to_submit_a_pull_request_on_github.md

File metadata and controls

47 lines (31 loc) · 2.13 KB
Raw

How to Submit a WSO Pull Request on Github

Assuming that you have the following local setup:

$ git remote -v
origin	   git@github.com:YourName/WebsiteOne.git (fetch)
origin	   git@github.com:YourName/WebsiteOne.git (push)
upstream   https://github.com/AgileVentures/WebsiteOne.git (fetch)
upstream   https://github.com/AgileVentures/WebsiteOne.git (push)
  1. First, make sure you are checked in to the right branch:
$ git checkout <your_feature_branch>
  1. Pull the most recent version of 'develop' from the WSO GitHub repo with
$ git pull upstream develop

This fetches and merges your current branch with the latest upstream/develop branch. If any conflicts need to be resolved at this step, how you do so will depend on what tools/IDE you use locally. This goes beyond a quick explanation - pair with someone if you get stuck.

  1. Run all tests.

  2. Push the feature branch up to your GitHub repo with

$ git push origin <your_feature_branch>
  1. When you view this branch on GitHub, click the gray button that says 'New pull request':

Or, if you visit your repo shortly after pushing the branch, there will be a prominent notice about the push, with a prompt to create a pull request:

  1. Fill out the description including "fixes #123" (replacing 123 with the id of the GitHub issue you've been working on) & a brief description of what you've done and create the pull request.

  2. Your branch's last commit will now be tested automatically by Semaphore CI. Keep an eye on the result, which typically takes less than 15 minutes to appear:

Click on the red cross to be taken to Semaphore CI. where you can scroll through the tests to see the failure(s).

  1. If your build passed, wait for code review comments, make necessary changes to your code, and repeat the process starting from Step 1 as many times as necessary.

Once your pull request has been accepted and merged into the application's code base, the related GitHub issue will automatically be closed if you correctly add the appropriate sentence to the description, e.g. 'fixes #123'.