[Guide] How to use Github

Hi.
Today I would like to show you how to use github. I'm not an expert (I'm rather n00b TBH ) but I learned some things and might help you with simple git commands.

1. Github? What's that?

In short it's the web-based hosting service for software development projects that use the Git revision control system. In English - the place where you store your sources.



2. Creating an account.

• 2.0 Download the required libs
  
  Code:

  sudo apt-get install git

• 2.1 Create an account on github.com website
• 2.2 In terminal type:
  
  Code:

  git config --global user.name "Your Name Here"
  git config --global user.email "your_email@youremail.com"

  
  NOTE: use the e-mail used in the website account creation
  2.3 Create your unique SSH public key
  
  Code:

  ssh-keygen -t rsa -C "your_email@youremail.com"
  # Creates a new ssh key using the provided email
  # Generating public/private rsa key pair.
  # Enter file in which to save the key (/c/Users/you/.ssh/id_rsa): [Press enter]

  Now you need to enter a passphrase.
  
  Code:

  # Enter passphrase (empty for no passphrase): [Type a passphrase]
  # Enter same passphrase again: [Type passphrase again]

  
  Which should give you something like this:
  
  Code:

  # Your identification has been saved in /c/Users/you/.ssh/id_rsa.
  # Your public key has been saved in /c/Users/you/.ssh/id_rsa.pub.
  # The key fingerprint is:
  # 01:0f:f4:3b:ca:85:d6:17:a1:7d:f0:68:9d:f0:a2:db your_email@youremail.com

  
  Now go to ~/.ssh folder and copy your id_rsa.pub content into account administration on github.com
  
  
  
  
  ... and check if everything works
  
  
  Code:

  ssh -T git@github.com

  Code:

  The authenticity of host 'github.com (207.97.227.239)' can't be established.
  # RSA key fingerprint is 16:27:ac:a5:76:28:2d:36:63:1b:56:4d:eb:df:a6:48.
  # Are you sure you want to continue connecting (yes/no)?

  
  Duh?! Sure I want! Yes! Yes! Yessss!
  
  
  Code:

  # Hi username! You've successfully authenticated, but GitHub does not
  # provide shell access.

And we are ready to do some serious things! :highfive:

3. Forking a repo

As an example I'll use https://github.com/CyanogenMod/android_packages_apps_Settings
Open this link in the browser and click fork.

• 3.1 Clone the source from your fork.
  I use my account as an example.
  
  
  Code:

  git clone git://github.com/eagleeyetom/android_packages_apps_Settings.git -b gingerbread

  
  -b gingerbread let us to choose what branch are we going to download
  
  
  
  
  
• 3.2 Do some changes!
  
  For example add files, remove them etc.
  
• 3.3 Commit the changes
  
  OPTIONAL I created new branch at my project and named it "xda"
  To do this go to the cloned folder and type:
  
  Code:

  git branch xda
  git checkout xda

  
  Now it's time to see what's going on:
  Magic command
  
  Code:

  git status

  
  
  
  
  
  As you can see I removed few files and added one.
  
  Now it's time to tell the git what we want to do.
  
  4. Pushing the changes
  
  Add all modified files:
  
  Code:

  git add .

  
  Add all removed files
  
  Code:

  git add -u

  
  You can also add/rm one file
  
  Code:

  git add name_of_file
  git rm name_of_file

  
  After git status we should get something like this:
  
  
  
  
  
  Now it's time to commit:
  
  
  Code:

  git commit -m 'my first commit'

  
  And finally to push:
  
  
  Code:

  git push

  
  If you'll get some errors use the following:
  
  
  Code:

  git push git@github.com:eagleeyetom/android_packages_apps_Settings.git xda

  I used the name of my github and the name of the branch in the end.
  
  
  
  
  
  Woo hoo! Now let's check the website.
  
  
  

That's the most basic basics
In the next posts I will show you some more advanced commands like merge, cherry-pick, removing branches etc.


Credits:
Google
Github Team
All my friends from GingerDX IRC channel

If you find it useful hit thanks button. You can also consider a small donation

5. Removing branch.
This one took me a lot of googleing and many bad words has been said

I'll make a test branch 'deleteme'


And I have new remote branch now.
But I want to delete it.
Here's the answer.
First:
Check the branches:
And I'll get:

I want to delete this branch.
Type:

And the remote branch is gone! Yeah!

6. Merging the commits
Imagine the situation that you want to add a commits created by someone else. Let's use our great Recognized Developer nobodyAtall

We need to add the source:

Download the branch:


You'll get a message to resolve the conflicts. In short and most n00b friendly way is to open pointed files and delete the:
<<<<<<<<
=======
>>>>>>>>
symbols.

Don't forget to test make before pushing!

Now standard procedure:

7. Cherry-pick the single commit
Now it's time to add specific commit to our build. I'm going to use this one.

And we're good :highfive:
Now commit should be added. All you need now is to push - no need to commit

8. Changing the branch
While using git you may noticed that sometimes after fresh sync there is no branch selected. Imagine the situation when you are on a branch A and want to check to branch B, because it uses a different method (like framework patch etc.)
The solution is pretty simple.
It allows you to change the branch to remote one without cloning the whole repo again.

Pull request

If you feel that you have fixed a problem and want to help the developer to make his own ROM/kernel etc. you should consider to make a pull request. Pull request adds the changes you have made to the others repo.

First of all.
Fork and clone destined repo.
Check the previous post about forking and cloning.
Now make some changes and upload it to your own remote git.

Then, go to your forked repo using browser and click on Pull request.



Then choose the account and branch to pull-request.



Click and wait for your request to be merged

Merging a pull request.
Sometimes someone wants to add something to your code.
You'll be notified by e-mail and also see the notification on your github website.

Go there and click Open



When the changes can't be merged you'll see such message:



But when it's green, you are ready to merge it



Don't forget to review the code. In other way you'll be forced to delete the commit.

You can also use text method:


or


TIPS AND TRICKS

REVERT CHANGES

To discard all unstaged changes e.g. failed merge etc. type:

You can also use:

HOW TO REMOVE COMMITTED CHANGES?

To remove committed changes you have to revert the commit. But how to do that? It's your answer

HEAD is the previous commit. To revert to previous state use HEAD~1, HEAD~2 etc. you can also use the code taken from git log.

GIT PATCH AND GIT APPLY

Now I want to make a patch file to e.g. send an e-mail with my commited changes.

First I need to find a changes made by a commit. To do this I need to know commit ID.

Now pick the commit for example 22a95d1 and use git show to make a patch


And I got patch, but how to apply it?
The answer is easy. Use git apply.


FORCE PUSH
Sometimes github doesn't want to cooperate - just like some people
You can force it by adding --force or -f
n00b method to add changes after failed push.
Clone the repo and delete everything but .git directory. Then copy modified content, commit and push

Stickied this...

good learning guide to show people how to use github when starting out for sure.

Mysteryagr said:

First of all, I'm new to this
I setup everything according to the tutorial.
Now I'm upstreaming sony 2011 stock kernel 2.6.32.9 on local repo and I want to sync changes to github repo.
Acording to "git status" command I've modified and deleted files.
should I use this command " git add . " then " git add -u"
or just "git add ." ??
Excuse me for being noob , Just want to make sure that I do the right thing.
Thanks in advance.

Click to expand...

Click to collapse

You should execute both commands. And no need to apologize, mate We're here to learn