Thanks for taking the time to make the osu! wiki better!
Anyone is allowed (and encouraged!) to contribute to the osu! wiki.
The osu! wiki is formatted using Markdown (specifically GitHub-Flavoured Markdown (GFM)), a markup language that allows for text to have basic styling.
adam-p's Markdown Cheatsheet is a fantastic tool of reference if you need to quickly learn about or refresh your memory of a Markdown feature.
Since the osu! wiki is managed through this GitHub repository, you'll need some basic knowledge of Git in order to contribute.
Luckily, if you're not willing to get too involved with the technicalities of Git, GitHub provides some on-site tools that can help you easily make changes. The osu! wiki contribution guide explains step-by-step how to utilise them in order to make changes to the osu! wiki, assuming that you have no prior knowledge of Git or GitHub.
The Article Styling Criteria (ASC) is a set of standards that must be adhered to for all new and edited articles going forward. Among these are rules regarding project structure, usage of Markdown, formatting, diction and grammar. Please refer to it if you have any specific questions or concerns.
The ASC is fairly verbose and encompasses many minute details, that are not necessary to memorise in order to take the first step of contributing to the osu! wiki. Have a look at the contribution guide, and other contributors will also be happy to answer your questions in the #osu-wiki channel of the osu!dev Discord server.
All pull requests are automatically run through a series of continuous integration checks (CI) in order to catch various common errors.
For people familiar with the command line, these checks can also be run locally.
- Docker Engine (part of Docker Desktop). Tip: on Linux, use convenience installation scripts to save time.
Run from the repository root on your feature branch:
./run-checks.shTo reclaim space occupied by the osu-wiki Docker image and its dependencies, run:
docker image rm osu-wiki -f && docker system prune --filter label=osu-wiki