John's GitHub page

From ProgClub
Revision as of 07:41, 27 February 2017 by John (talk | contribs) (→‎Create a pull request: removing spurious word...)
Jump to: navigation, search

OK. Hi there. I'm John. So recently I've made some modifications to code that is hosted on GitHub, as you can see in my account. I'm new and still learning the process, so here's what I've figured out:

Submitting a patch via GitHub

Fork the upstream repository into a project in your account

  1. go to GitHub
  2. login
  3. navigate to the project repository you want to fork
  4. click 'Fork' on the top right

Clone your fork

  1. open a terminal on your workstation
  2. change dir to your github directory (I use /home/jj5/repo/git/github/jj5)
  3. clone your fork (using SSH) with: git clone git@github.com/jj5/MyProject.git

Make a topic branch in your fork

You can read about what a topic branch is.

  1. open a terminal on your workstation
  2. change dir to your github fork (e.g. /home/jj5/repo/git/github/jj5/MyProject)
  3. create a branch with: git branch branch-name
  4. switch to your new branch: git checkout branch-name

Note: you can create a branch and check it out with one command: git checkout -b branch-name

Question: is 'switch' the correct verb for changing between branches?

Make your changes

So edit files, add files, etc.

Tell git about new files

If you've added files include them in git with: git add file.name

Commit your changes on the topic branch

To commit your changes: git commit -a -m 'What you did...'

Push your changes into your fork at GitHub

To push your topic branch upstream: git push --set-upstream origin branch-name

Create a pull request

  1. go to GitHub
  2. login
  3. navigate to your fork in your account
  4. in the top left select your topic branch for the Branch drop down
  5. click 'New pull request'
  6. the 'base fork' should be the project you forked from that you wish to contribute to
  7. the 'base' branch is the branch you want to merge with (probably 'master'?)
  8. the 'head fork' is where your proposed changes are (i.e. in your fork)
  9. the 'compare' branch is the branch that has your changes (i.e. your topic branch)
  10. add a message, check your changes, and submit your way to victory!