Skip to content

GitHub contribution for beginners

Viktor Kovacs edited this page Sep 14, 2024 · 6 revisions

This document helps you through your first contribution.

Preparation

  • Create a GitHub account. You will need this to contribute.
  • Download GitHub Desktop. This is the official desktop client for GitHub. I recommend using this for beginners, since it's very easy to use, and seamlessly works together with GitHub.

Create a fork

Go to the Tapir repository and create a fork. A fork is your very own copy of the repository under your GitHub account. You can make any changes in the fork, and merge it back later to the main repository.

image

Create a branch on your fork

It is recommended to create a branch for each and every of your contributions. Go to the front page of your fork, and create a branch for your contribution.

image

Get the code on your computer

Open GitHub Desktop, and clone your fork. When the cloning is finished, switch to your branch.

image

image

Make your changes to the code

Modify the code base according to your needs. When you are ready, open GitHub Desktop to see all the changes you've made. If you are satisfied with the changes click on commit, and then push. You can commit and push as many times you want.

image

image

Create a pull request

Whenever you've finished, create a pull request. From now it's up to the Tapir contributors to accept your changes.

image

image