GitHub

GitHub#

GitHub is a web-based platform that provides tools for version control and collaborative software development. It allows developers to host their code repositories online, track changes to code over time, and work together with others on the same codebase.

Generating an SSH key#

If you haven’t already, generate an SSH key on your laptop. See SSH for instructions.

You can view the public key by:

$ cat ~/.ssh/id_rsa.pub

  • Highlight and copy the entire public key to your clipboard.

../_images/copyssh.png

Uploading to GitHub#

  • Log in to your GitHub account and click on your profile picture in the top-right corner of the page.

../_images/Profile.png

  • Select Settings from the dropdown menu and in the left sidebar, click on “SSH and GPG keys”.

  • Click on the green New SSH key button and give your SSH key a descriptive title in the Title field.

../_images/Title.png

  • Paste the entire public key you copied earlier into the Key field and click on the green Add SSH key button.

  • Your SSH key is now uploaded to GitHub and you can now use SSH to authenticate with GitHub and perform various Git operations.

Cloning a repository#

  • Open your terminal on your laptop.

  • Clone the repository using the SSH URL. For example, if the repository URL is git@github.com:USERNAME/REPOSITORY.git. USERNAME and REPOSITORY need to be change to your own. You can clone it by running this command:

$ git clone git@github.com:USERNAME/REPOSITORY.git
../_images/git_clone_ssh.png

  • Navigate to the cloned repository using the cd command.

$ cd REPOSITORY

Making changes#

  • Make the changes you want using your desired text editor.

  • Stage all the changes you made using the git add command.

$ git add .

Committing changes#

  • Commit the changes using the git commit command. Where the commit message is the changes you made.

$ git commit -m 'commit message'

Push the changes#

  • Push the changes using git push command.

$ git push

Pull request#

  • Go to the repository on github and click on pull request tab

and then click on the green New pull request button.

../_images/Pull.png

  • Select the branch with your changes from the base dropdown menu and the branch you want to merge into from the compare dropdown menu.

  • Review the changes in the pull request and add a descriptive title and description. Click on the green Create pull request button.

  • Write a description of changes made and click on Create pull request button. The pull request will be sent to the repository owner for necessary review.

More information#

Contents