Contribute via Github

Prerequisites

To be able to contribute via pull requests, there are several prerequisites:

Know how to use a minimum of Git
Have a Github account
Have a fork of the project on which you wish to contribute

Before going into the details, it will be necessary to make a small point on the vocabulary. Here is a small glossary of words that we constantly use with Git/Github:

repo: Abbreviation of "Repository". We use this word to designate a set of files versioned with Git.
branch: This is a branch in a Git project. Branches allow you to create a parallel version of the code at some point in history.
master: Designates the main branch of the repo.
origin: Designates the remote repo. Hosted on Github, for example.
pull request: This is the operation that allows you to propose a code modification to a project on Github.
fork: This is a repo that is a copy of another repo. This allows you to start from an existing project in order to modify it, to improve it, correct it, or do something else with it.
upstream: In the case of a fork, designates the repo from which the fork comes.
fetch: This is the operation consisting in retrieving data from the remote locally.
push: This is the operation allowing local data to be sent to the remote.

Configuration

Fork

The first thing to do is to go to Github, in order to create a fork of the project to which you wish to contribute.

For example, to contribute to the Leek Wars client, go here: Leek Wars Client

Then, just click on the "fork" button at the top right.

By "forking" the project, Github will create a new repo on your account. This will be a copy of the original project.

Then get the address of your github repo, via the url address, or by clicking on the green "Clone or download" button.

Go to the location where you want to place your local repo and use the command: git clone \ Don't forget to replace "\".

Here is. You have created a fork of the project and you have retrieved it locally, on your machine. But there is one more thing to do to be able to continue using it without worries in the future.

Upstream

You must then configure the upstream, which will allow you to update your repo from the project one.

The git remote -v command allows you to list the configured remote addresses.

origin https://github.com/YOUR_USERNAME/YOUR_FORK.git (fetch) origin https://github.com/YOUR_USERNAME/YOUR_FORK.git (push)

For now, you should see two addresses configured as origin. One in fetch, when you want to repatriate new features from your remote, your repo hosted on Github. And the other in push which, conversely, allows you to send your local news to the remote repo.

To this, we will add the upstream. To do this, get the address of the project you just forked. Always via the url, or the "Clone or download" button.

The command to add the upstream is: git remote add upstream \

If you run the git remote -v command again, you should now see four entries. Two for the origin and two for the upstream. Each duplicated into a fetch and a push.

origin https://github.com/YOUR_USERNAME/YOUR_FORK.git (fetch) origin https://github.com/YOUR_USERNAME/YOUR_FORK.git (push) upstream https://github.com/ORIGINAL_OWNER/ORIGINAL_REPOSITORY.git (fetch) upstream https://github.com/ORIGINAL_OWNER/ORIGINAL_REPOSITORY.git (push)

You are ready to contribute now!

Keeping up to date

(Step not necessary if you just fork.)

Chances are that the project you are contributing to is not set in stone. The people who take care of it will make it evolve. Other contributions will potentially be accepted.

Your repo can therefore quickly become obsolete. And that could be a problem.

If originally a file contained "A", and you want to submit a contribution to change this "A" to "B". In the meantime, maybe someone else will have made a change from this "A" to "C".

And when you propose your modification, there will be a conflict. Cannot change "A" to "B" since "A" is no longer present in the file.

In short, it is important to keep the repo up to date in order to avoid unpleasant surprises.

Don't worry, now that you've configured the upstream, it'll be a piece of cake!

The first thing to do is get the new m