Skip to content
Permalink
Fetching contributors…
Cannot retrieve contributors at this time
206 lines (177 sloc) 8.29 KB
layout title questions objectives time_estimation key_points contributors
tutorial_hands_on
Contributing with GitHub via its interface
How can I contribute to an open-source project with GitHub and its interface
Edit a file via GitHub interface
Create a pull request
Update a pull request
20m
You can't add or push directly to the `master` branch, so you need to create a pull request
1 pull request = 1 branch
The pull request is the foundation of the collaborative development of the training material
bebatut

Introduction

{:.no_toc}

All the training material which you find on [{{ site.url }}{{ site.baseurl }}/]({{ site.baseurl }}/) is stored on a GitHub repository ([{{ site.github.repository_url }}]({{ site.github.repository_url }})), a code hosting platform for version control and collaboration. GitHub interface is quite intuitive and simplifies the contributions from anyone.

Agenda

In this tutorial, you will learn how to use GitHub interface to contribute to the training material:

  1. TOC {:toc}

{: .agenda}

GitHub

The GitHub repository for the training material is: [{{ site.github.repository_url }}]({{ site.github.repository_url }}).

{% icon hands_on %} Hands-on: Familiarization with GitHub

  1. Go on the GitHub repository: [{{ site.github.repository_url }}]({{ site.github.repository_url }})

    GitHub interface

  2. Click on CONTRIBUTORS.yaml file

    Click on CONTRIBUTOR

  3. View the file

    You should see something like:

    Click on CONTRIBUTOR

{: .hands_on}

This CONTRIBUTORS.yaml file is where we collect the information (name, email, etc) about the different contributors to display them on our [Hall of Fame]({{ site.baseurl }}{% link hall-of-fame.md %}). You will add your information there. But first you need to sign in to GitHub to be able to change this file.

{% icon hands_on %} Hands-on: Sign in to GitHub

  1. Create a GitHub account (if you do not have one already)

    GitHub signup

  2. Sign in (once you have a GitHub account)

{: .hands_on}

Edit a file

You can now modify the CONTRIBUTORS.yaml file to add your information there

{% icon hands_on %} Hands-on: Edit a file

  1. Open the CONTRIBUTORS.yaml file on GitHub

  2. Click on {% icon hands_on %} icon (top right of the file)

    GitHub edit

    A new page will open:

    GitHub contributor edit page

  3. Modify the CONTRIBUTORS.yaml by adding yourself

    You should use your GitHub username and add it followed by : (the : is important) at the correct position given the alphabetical order.

  4. Scroll down to the bottom of the file

  5. Fill the Propose file change form

    It can also be named Commit changes for the ones with write accesses to the repository

    1. Fill the box "Update CONTRIBUTORS.yaml" with "Add < GitHub username > as contributor" (replace < GitHub username > by your GitHub username)

      {% icon comment %} Commit messages

      This a commit message: a description explaining why a particular change was made. Theses messages capture the history of the changes, so other contributors can understand what have been done and why {: .comment}

    2. Leave "Add an optional extended description..." empty

    Propose file change form

  6. Click on Propose file change

    Submit propose file change form

{: .hands_on}

Without realizing it, GitHub let you create your first branch (named here patch-1) and add a changement on this branch.

{% icon comment %} Branching

Branching is the way to work on different versions of a repository at one time. By default your repository has one branch named master which is considered to be the definitive branch. When you create a branch off the master branch, you're making a copy, or snapshot, of master as it was at that point in time.

By changing a file in this branch, it will diverge from the master branch. It will contain data that is only on this new branch. {: .comment}

Open a Pull Request

Then the addition of your information in the CONTRIBUTORS.yaml file is currently only on your branch patch-1. Not on the master branch and so not only on the [Hall of Fame]({{ site.baseurl }}{% link hall-of-fame.md %}). You can't add or push directly to the master branch, so you need to create what we call a pull request.

The GitHub interface guides you through this process: after clicking on Propose file change, a new page opens:

Pull request form

{% icon hands_on %} Hands-on: Edit a file

  1. Open and read the [CONTRIBUTING.md]({{ site.github.repository_url }}/blob/master/CONTRIBUTING.md) file

  2. Come back to the pull request

  3. Fill in the pull request description

    Pull request description

    1. Add a title for the Pull Request

    2. Add a message explaining the changes you made

      This message is a good way to introduce yourself and to explain the message you made. Be kind and descriptive. It helps the reviewers to understand why you did your changes and if it should be intergrated into the master branch (and then website).

      {% icon comment %} Pull request messages

      GitHub uses Markdown, a simple Markup language, to render the Pull request messages. You can then add bold test, lists, images, etc. {: .comment}

  4. Scroll down and check the changes you made

    • In green with +: what you added
    • In red with -: what you deleted
  5. Click on Create pull request {: .hands_on}

You have created your first pull request!

Your pull request will be reviewed. There are two possible outcomes:

  1. Your pull request is accepted. Congratulations! Your changes will be merged into the master branch of the original repository. The website will be re-built and you will be in the [Hall of Fame]({{ site.baseurl }}{% link hall-of-fame.md %})
  2. Your pull request needs modifications: the reviewers will ask for some changes, possibly because the automatic tests are failing.

Update a Pull Request

One of the reviewers of your pull request asked you to add your name after your GitHub username in the CONTRIBUTORS.yaml file.

{% icon hands_on %} Hands-on: Update a Pull Request

  1. Go to the list of pull request tab on GitHub

  2. Click on your pull request

    You can see here the comments the reviewers left you

  3. Click on Files changed tab and see the changes you made

    Pull request files changed tab

  4. Click on {% icon hands_on %} icon

  5. Add your name below your GitHub username

    It should look like:

    bebatut:
         name: Bérénice Batut
    
  6. Navigate to the bottom of the file

  7. Fill the Commit changes form, similarly to the Propose file change form before

  8. Make sure the Commit directly to the patch-1 branch is selected

    Commit directly to the patch-1 branch

  9. Click on Commit changes

    Submit propose file change form

    The pull request should be automatically updated

  10. Check that the new changes are added to the pull request on GitHub

{: .hands_on}

Conclusion

{:.no_toc}

With this tutorial, you learn how to use GitHub to change a file, create a pull request and then contribute to the training material. What you have learned here can be applied to any file.

{% icon details %} More about GitHub

Via the GitHub interface, you can also go further: create file, branch directly, etc. To learn that, we recommend you to read the GitHub guide {: .details}

You can’t perform that action at this time.