Skip to content
Ahmad Ammar

1. What contributing means

Open-source software is software whose code anyone may read and improve. Contributing means proposing a change to such a project. The change need not be code. Fixing a spelling mistake in the instructions counts, as does clearing up a confusing sentence, reporting a problem clearly, or adding a test. Beginners are often the best people to improve instructions, because they notice what the instructions assume.

You cannot damage a project by trying. Nothing you do reaches it until one of its maintainers, the people who look after it, reads your proposal and accepts it.

1.1 The whole journey

  1. Find a project and a small thing to improve.

  2. Make your own copy of the project on GitHub. This is a fork.

  3. Download your copy to your computer.

  4. Make a branch, which is a separate line of work.

  5. Change the files, check them, and save a version.

  6. Send the branch to your copy on GitHub.

  7. Open a pull request, asking the maintainers to take your change.

  8. Answer their comments until the change is accepted or closed.

1.2 The words you will meet

Git and GitHub have their own vocabulary. You do not need to memorise this table, so come back to it when a word looks unfamiliar.

Word Meaning
Repository A project folder whose history Git keeps. Often shortened to repo.
Commit One saved version of your files, with a short note saying what changed.
Stage (or add) Choosing which changes go into the next commit.
Push Sending your new commits from your computer to GitHub.
Pull Bringing new commits from GitHub to your computer.
Clone Downloading a repository, with its history, to your computer.
Branch A separate line of work, which lets you try a change without disturbing the main version.
main The usual name of the main branch.
Fork Your own copy, on GitHub, of someone else’s repository.
Pull request A request asking a project’s maintainers to take in your changes.

1.3 The terminal, and how to read the commands here

A terminal is a window where you type instructions to your computer instead of clicking. It looks severe, but it only does what you type, and most commands in this guide are safe to repeat.

In VS Code, open the Terminal menu at the top of the window and choose New Terminal. A panel opens at the bottom of the window with a line that waits for you to type. That line is called the prompt. It usually ends in > or $ and shows the folder you are in.

When this guide shows a command, type everything on that line, then press Enter. Where a block shows a line beginning $, the $ stands for the prompt, so do not type it. The lines beneath it are what the computer prints back. Yours will match closely, although codes such as 1a2b3c4 will differ.

If a command prints something you did not expect, nothing is broken. Read the message, because it usually says what to do next. To stop a command that seems stuck, press Ctrl and C together.