Contribute directly to the repository on GitHub

Direct collaboration via GitHub is practical if you want to regularly correct pages, create new Markdown files, or work with the CircusWiki vault in an editor like Obsidian.

If you only want to contribute a game, a method, a PDF, a link, or a correction, the simpler method is usually better:

Back to Contribute

What You Need¶

• A free GitHub account: https://github.com/join
• Optionally, GitHub Desktop: https://desktop.github.com/
• A text editor for Markdown files, for example Obsidian, VS Code, or a simple editor

GitHub Desktop is not mandatory, but it's easier for many people than using the command line.

Finding the Repository¶

The public repository is located here:

https://github.com/nica-ev/circuswiki

This is where the actual Markdown files, images, translations, and tools are stored, from which the website is built.

Workflow in Brief¶

The typical process is:

1. Fork the repository on GitHub.
2. Clone your copy to your own computer.
3. Make changes in a new branch.
4. Edit files or create new Markdown files.
5. Commit changes.
6. Upload the branch to GitHub.
7. Open a Pull Request so the changes can be reviewed and merged.

Step-by-Step with GitHub Desktop¶

1. Fork the Repository¶

Open the CircusWiki repository on GitHub:

https://github.com/nica-ev/circuswiki

Click Fork. This creates your own copy of the repository in your GitHub account. You can work in this copy without directly altering the main project.

2. Clone the Repository¶

Open GitHub Desktop and select:

File -> Clone repository...

Choose your fork of nica-ev/circuswiki and specify a folder on your computer.

After this, you will have a local copy of the files.

3. Create a Branch¶

It's best to create a separate branch for your changes, for example:

add-game-description
fix-link
new-balancing-method

A branch keeps your work separate from the main codebase. This makes the later review process easier.

4. Edit Files¶

The public content is primarily located in the language folders under docs/:

docs/de/
docs/en/
docs/es/
docs/pl/
...
docs/img/

All languages are treated equally. There is no primary language in which new content must fundamentally originate.

If you are creating a new original page, place it in the language folder corresponding to the language of the text. For example, an original Spanish text belongs in docs/es/, an original German in docs/de/, and an original English in docs/en/.

The front matter at the beginning of the file is important. It must indicate that the page is an original, for example:

translation_status: original
translation_source_lang: es

translation_source_lang should correspond to the language of the original text. From this original, translations into all supported languages can be automatically generated later.

When editing, pay attention to the following:

• Do not delete the front matter at the beginning of the file.
• For new original pages, set translation_status: original and the appropriate translation_source_lang.
• Preserve existing links as much as possible.
• Do not publish private data, API keys, or internal notes.
• Only use images if the usage rights are clear.
• Make small, clear changes rather than very large, mixed changes.

5. Commit Changes¶

In GitHub Desktop, you will see your changed files in the Changes section.

Write a brief summary, for example:

Correct material list in movement game
Add safety note for Beigoma
Add new game description

Then click Commit to <branch-name>.

6. Upload Changes¶

Click Push origin to upload your branch to GitHub.

7. Open a Pull Request¶

GitHub Desktop or GitHub in your browser will then offer to create a Pull Request.

A Pull Request means: You are proposing your changes for the main repository. The changes will be reviewed, possibly commented on, and then merged or further developed.

Markdown Basics¶

Markdown is a simple text format. The most important characters are sufficient for most contributions:

# Main Heading
## Section Heading

Normal text with **bold text** and *italic text*.

- List item
- Another list item

[Link text](https://www.example.com)

If Something is Unclear¶

You don't need to be perfect at direct collaboration via GitHub right away. If you open a Pull Request and something isn't quite right, it can be clarified during the review.

If you only want to contribute content and the technical process seems too complex, simply use the email on the Contribute page.