Skip to content

Commit

Permalink
URL correction in second stage of PR submission instructions (#161)
Browse files Browse the repository at this point in the history
* Adding my name, and a link to PR howto

* Changing absolute link to relative

* Update loops-in-progress.md

* Proper Markdown-ified relative link.  I think.

* Small URL correction
  • Loading branch information
Spazholio authored and scottleibrand committed May 13, 2016
1 parent c28e198 commit 1d24c3d
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions docs/docs/Resources/my-first-pr.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,15 @@ OK, let's get started. For our example we are going to make an edit to the opena

We now have an improved file that we want to be pulled back into the dev repository at https://github.com/openaps/docs

1. Go to https://github.com/openaps/docs
2. Click the green "New pull request" button
3. Under the Compare Changes heading, click "compare across forks"
4. Set up the the branches you are targeting. The easiest way of thinking about the branch range is this: the base branch is where you think changes should be applied, the head branch is what you would like to be applied.
5. So, choose the base fork as openaps/docs and then the base as dev. The head fork is going to be <i>youraccount</i>/docs and the base as dev.
1. Go to https://github.com/[YOUR_GITHUB_USERNAME]/docs
* Or you can go to https://github.com and then click on "docs" in the "Your repositories" section in the lower right. Both methods will get you to the right place.
2. Select "dev" from the branch drop down on the upper left (since that’s where we’d like the changes to go to)
3. Click the green "New pull request" button
4. Under the Compare Changes heading, click "compare across forks"
5. Set up the the branches you are targeting. The easiest way of thinking about the branch range is this: the base branch is where you think changes should be applied, the head branch is what you would like to be applied.
6. So, choose the base fork as openaps/docs and then the base as dev. The head fork is going to be <i>youraccount</i>/docs and the base as dev.
![Pull Request](../Images/Pull_Request.png)
6. It should show the list of changes you made. If not, you did something wrong so stop here and ask for help. If the list looks like your changes then put a note in there to what the overarching reason for the changes are (in your case you only made one, but you could have made a bunch). Create the PR.
7. It should show the list of changes you made. If not, you did something wrong so stop here and ask for help. If the list looks like your changes then put a note in there to what the overarching reason for the changes are (in your case you only made one, but you could have made a bunch). Create the PR.

It will now be in a list of PR's that the team will review and potentially give feedback on before committing to the main documentation for openaps!

Expand Down

0 comments on commit 1d24c3d

Please sign in to comment.