This blog post is a HOWTO guide for using github while collaborating during hackathons. It does not cover git in detail.
One time setup
- Create github account by visiting https://github.com
- Generate SSH key locally and upload it to github
This setup ensures password-less (code) pull and push from github.
Per project setup
- Create a repo on github by submitting form at https://github.com/new
- Clone the repo locally using
git clone firstname.lastname@example.org:<username>@<reponame>.gitThis URL is mentioned on the bottom right side of the repo page.
Note: It’s recommended to use the above style (SSH) instead of the HTTPS style so that, future submissions do not require retyping password.
- This will clone the (empty) repo into <reponame> directory.
- After “cd”ing that directory, you will be working on the master branch.
- Change to a new branch say
git checkout -b user1Note: “-b” creates a branch and checks it out. If branch already exists, the command will fail, remove “-b” to check out (work on) that branch.
- To see which branch you are currently and how much its modified use,
- Now modify the files.
- To add a new file, after creating the file, do
git add filename
- To remove a file, do
git rm filename
- All the changes made till this point are uncommitted, to see what changes will be committed in next commit, use
- Once the changes look good, commit them using
git commit -m "<commit message goes here>"
- Now, the changes have been committed locally to user1 branch, to push the changes back to remote server (github), use
git push origin user1
- Now the changes have been pushed to user1 branch on github server. Merge them by creating a pull request using master as base and user1 as branch to be merged.
- Step 13 can fail master has changed since the last time user1 was updated with master (in step 5). A fix for that is to execute following command before doing git push (step 12).
git pull origin masterIn case of merge conflicts, this pull will produce files which had merge conflicts, review them looking for conflict markers (“<<<<“, “>>>>”) and merge the code manually.
After than perform another commit using git commit and continue from step 12.
Some more productivity tools focused on git