Skip to content
Wout Dillen edited this page Apr 20, 2022 · 4 revisions

Welcome to the pizzaParty wiki! If you want to learn some basic GitHub operations and/or share your own amazing pizza recipe with Wout, you've come to the right place! Just follow the directions below.

These instructions do not require any previous knowledge about git or GitHub, but do assume that you have an active GitHub Account, and that you have downloaded the GitHub Desktop software.

For a low-threshold introduction to git and GitHub, including a quick introduction to this repository, a live run-through of some of the commands of your basic git and GitHub workflows, and definitions of concepts like fork, commit, push, and pull request be sure to check out this repository's accompanying video lecture.

Fork This Repository

On the top right of this page (or any page belonging to this repository), you can find a Fork button.

  1. Click on the button
  2. Agree to Fork this repository onto your account
  3. Open GitHub Desktop
  4. Click on Add > Clone Repository...
  5. Select the forked repository
  6. Select a place where to save your clone of the repository
  7. Click on the 'History' tab to get an overview of all the repository's past commits.

Add Your Content

Now, you can start making changes to your own copy of the repository.

  1. Find the repository on your computer (this is where you saved it in 6. above).
  2. Duplicate one of the files (e.g. GOAT.md)
  3. Open the duplicated file in a text editor (like oXygen, SublimeText, Visual Studio Code, Atom, ...)
  4. Change the filename of the pizza into something unique
  5. Change the pizza's ingredients
  6. Change the pizza's name
  7. Save your changes
  8. Go back to GitHub Desktop
  9. Have a look at what's in the 'Changes' tab
  10. Write a commit message (e.g.: added [pizzaname]). You can also use emoticons in your commit messages! 🍕
  11. Commit the changes

Push Your Content

  1. Still in GitHub Desktop, click on the button to push your changes to the remote repository
  2. Visit your online account on the GitHub website
  3. Find your repository
  4. Admire your changes

The new pizza file you added to the repository should now be visible in the overview of your repository's file and folder structure. As you'll see, the overview also states for each file or folder when its most recent changes took place, and what the message of the relevant commit was. This is why it's useful to write meaningful commit messages: it makes it easier to navigate both your files and your revision history at a glance.

Just above your repository's updated file structure, you can also find some more information about your latest commit, and click through to a list of all the commits that have been made to this repository. Including those made by the people you forked the repository from.

Put in a Pull Request

  1. In case you moved away from your repository since completing the previous task, go back and visit your repository again.
  2. On the top of the page, find the button called Pull requests
  3. Continue to create a pull request
  4. Be sure to mention #1 in your commit message -- if you added a new pizza. This will link the commit to the relevant issue in this repository.
  5. Send the pull request
  6. Wait until Wout merges your request into his branch
  7. When you visit the original repository, your changes will be there now!
Clone this wiki locally