Basic Contribution Tutorial

Git can be confusing sometimes, so this page explains a way of contributing your changes and shouldn't run into the usual git troubles.

TL;DR: Fork the repo. And then always: Sync main, create new branch, commit changes on new branch, PR new branch. (In particular, never commit on main)

Initial steps (only once)

Forking the repository

Fork the repository by clicking the "Fork" button.

The default settings for the fork are fine.

Contribution cycle

Always repeat these steps for a new change. Never work on your old branches after they have been merged in the main repository.

1. Sync your main branch

• Switch to main branch
• Click "Sync fork"
• Click "Update branch"

If you're already up to date, you can skip this step.

2. Create a new branch based on the main branch

• Switch to main branch
• Click main in the branch selection
• Enter a new branch name (e.g. fix-frontpage-bug or update-readme or similar)
• Create this new branch

3. Do your changes on that new branch

Now it's time to change files around and thus improve the site!

4. Pull Request (PR) your changes

• Make sure you're on your new branch
• Click "Contribute"
• Click "Open pull request"
• And then you can enter a title, a description, and submit your pull request.