Skip to content

Commit

Permalink
update INSTALL with PR instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
pybites committed Apr 17, 2017
1 parent 1a46929 commit da59f72
Show file tree
Hide file tree
Showing 4 changed files with 52 additions and 3 deletions.
55 changes: 52 additions & 3 deletions INSTALL.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
## To follow along with our challenges

### I. First time around
## I. First time around

* Make your own fork of our [challenges repo](https://github.com/pybites/challenges): use the Fork button at the top right of the page.

* Clone your copy:

$ git clone https://github.com/<your_user>/challenges

### II. You already cloned your fork
## II. You already cloned your fork

* In this case you need to [sync our new challenge(s)](https://help.github.com/articles/syncing-a-fork/), in your fork directory:

Expand All @@ -26,7 +26,56 @@
$ cd <challenge-number>
# edit <template>.py file

### III. Optional - Detaching the fork
## III. Submit your code to our community branch via a Pull Request (PR)

This is still a bit of an experimental feature. We will update it as we go. If there is an easier way please let us know ...

* Work on community branch and get into sync. In your forked repo:

$ git checkout community (might need -b the first time)

* Make sure you got the latest changes from PyBites:

$ git pull upstream community

* From your local community branch Open a new branch, we use PCC<challenge_num> here as convention (PyBites Code Challenge)

$ git checkout -b PCC14

* Add your code

$ cd <challenge_number>
$ mkdir <GH-username>
$ add files ...
e.g.
$ cd 14
$ mkdir bbelderbos && cd $_
$ vi some_script.py
...

* Commit your changes:

$ git add .
$ git commit -m "PCC14 bbelderbos"

* Push this local branch to your forked repo (origin is default remote after fork + clone):

$ git push origin PCC14

* Go to your cloned repo and open a PR by comparing pybites community branch with your newly pushed local branch (make sure only the files of your changes are included):

![step 1](PR1.png)

![step 2](PR2.png)

![step 3](PR3.png)

The difficult part here was isolating the changes. We think that if you do the "git pull upstream community" into your local community branch, as described above, you should see only your changes, but we have to do some more testing. Please let us know how this goes ...

Finally we will check your code, merge it into our community branch, and feature it in our end-of-the-week review post.

## IV. Optional - Detaching the fork

* One small issue with working with a forked repo is that Github wont actually recognize any of your activity. If you want to see your activity follow these steps. However be warned that it will prevent you from creating pull-requests.

Expand Down
Binary file added PR1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added PR2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added PR3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit da59f72

Please sign in to comment.