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

Time estimation: 20 minutes
Supporting Materials
Last modification: Mar 25, 2021
License: Tutorial Content is licensed under Creative Commons Attribution 4.0 International License The GTN Framework is MIT


All the training material which you find on is stored on a GitHub repository (, a code hosting platform for version control and collaboration. GitHub interface is quite intuitive and simplifies the contributions from anyone.


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

  1. GitHub
  2. Edit a file
  3. Open a Pull Request
  4. Update a Pull Request


The GitHub repository for the training material is:

hands_on Hands-on: Familiarization with GitHub

  1. Go on the GitHub repository:

    GitHub interface
    Figure 1: Interface of the GitHub repository of the training material
  2. Click on CONTRIBUTORS.yaml file

    Click on CONTRIBUTOR

  3. View the file

    You should see something like:

    Click on CONTRIBUTOR
    Figure 2: CONTRIBUTOR file

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. You will add your information there. But first you need to sign in to GitHub to be able to change this file.

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)

Edit a file

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

hands_on Hands-on: Edit a file

  1. Open the CONTRIBUTORS.yaml file on GitHub
  2. Click on hands_on icon (top right of the file)

    GitHub edit

    A new page will open:

    GitHub contributor edit page
    Figure 3: CONTRIBUTOR file in edit mode
  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)

      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

    2. Leave “Add an optional extended description…” empty

    Propose file change form

  6. Click on Propose file change

    Submit propose file change form

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

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 main which is considered to be the definitive branch. When you create a branch off the main branch, you’re making a copy, or snapshot, of main as it was at that point in time.

By changing a file in this branch, it will diverge from the main branch. It will contain data that is only on this new branch.

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 main branch and so not only on the Hall of Fame. You can’t add or push directly to the main 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
Figure 4: Pull request form

hands_on Hands-on: Edit a file

  1. Open and read the 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 main branch (and then website).

      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.

  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

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 main branch of the original repository. The website will be re-built and you will be in the Hall of Fame
  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.

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 hands_on icon
  5. Add your name below your GitHub username

    It should look like:

         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


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.

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

Key points

  • You can’t add or push directly to the main 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

Frequently Asked Questions

Have questions about this tutorial? Check out the FAQ page for the Contributing to the Galaxy Training Material topic to see if your question is listed there. If not, please ask your question on the GTN Gitter Channel or the Galaxy Help Forum


Did you use this material as an instructor? Feel free to give us feedback on how it went.

Click here to load Google feedback frame

Citing this Tutorial

  1. Bérénice Batut, 2021 Contributing with GitHub via its interface (Galaxy Training Materials). Online; accessed TODAY
  2. Batut et al., 2018 Community-Driven Data Analysis Training for Biology Cell Systems 10.1016/j.cels.2018.05.012

details BibTeX

author = "Bérénice Batut",
title = "Contributing with GitHub via its interface (Galaxy Training Materials)",
year = "2021",
month = "03",
day = "25"
url = "\url{}",
note = "[Online; accessed TODAY]"
    doi = {10.1016/j.cels.2018.05.012},
    url = {},
    year = 2018,
    month = {jun},
    publisher = {Elsevier {BV}},
    volume = {6},
    number = {6},
    pages = {752--758.e1},
    author = {B{\'{e}}r{\'{e}}nice Batut and Saskia Hiltemann and Andrea Bagnacani and Dannon Baker and Vivek Bhardwaj and Clemens Blank and Anthony Bretaudeau and Loraine Brillet-Gu{\'{e}}guen and Martin {\v{C}}ech and John Chilton and Dave Clements and Olivia Doppelt-Azeroual and Anika Erxleben and Mallory Ann Freeberg and Simon Gladman and Youri Hoogstrate and Hans-Rudolf Hotz and Torsten Houwaart and Pratik Jagtap and Delphine Larivi{\`{e}}re and Gildas Le Corguill{\'{e}} and Thomas Manke and Fabien Mareuil and Fidel Ram{\'{\i}}rez and Devon Ryan and Florian Christoph Sigloch and Nicola Soranzo and Joachim Wolff and Pavankumar Videm and Markus Wolfien and Aisanjiang Wubuli and Dilmurat Yusuf and James Taylor and Rolf Backofen and Anton Nekrutenko and Björn Grüning},
    title = {Community-Driven Data Analysis Training for Biology},
    journal = {Cell Systems}

Congratulations on successfully completing this tutorial!

Developing GTN training material

This tutorial is part of a series to develop GTN training material, feel free to also look at:
  1. Overview of the Galaxy Training Material
  2. Adding auto-generated video to your slides
  3. Contributing with GitHub via command-line
  4. Contributing with GitHub via its interface
  5. Creating a new tutorial
  6. Creating content in Markdown
  7. Creating Interactive Galaxy Tours
  8. Creating Slides
  9. Generating PDF artefacts of the website
  10. Including a new topic
  11. Running the GTN website locally
  12. Running the GTN website online using GitPod
  13. Tools, Data, and Workflows for tutorials
  14. Updating diffs in admin training