Thanks for your interest in making the osu! wiki better! This article covers the contribution process step by step. In case you are familiar with GitHub, feel free to follow the common feature-branch workflow for proposing changes and skip to the self-check section.
New contributors are not expected to be familiar with GitHub or git, because they're tools mainly tailored towards developers. Don't worry if you don't get something right the first time — a wiki maintainer will either point you in the right direction or fix it for you.
In case you need tips or advice during any stage, don't hesitate to ask in the
#osu-wiki channel of the osu!dev Discord server.
If you want to help, but don't know where to start, see osu! wiki maintenance § Routines for a list of tasks which need to be performed regularly, and for ways to help other wiki editors. To familiarise yourself with the formatting language used on the wiki, check Adam Pritchard's Markdown Cheatsheet.
For a generalised contribution process, see GitHub flow - GitHub Docs
The osu! wiki articles are stored on GitHub. To contribute, do the following:
When you are done editing, take some time to proofread your work. Go through the following quick checklist:
For more specific writing and formatting standards, refer to the article styling criteria. It's not recommended to read it all at once — a reviewer will likely point out if something needs to be corrected either way.
After the changes are double-checked, committed, and pushed to your fork, you need to propose them to the wiki maintainers by opening a pull request:
master↓, and select the branch with your changes.
Contribute↓button and select
Open pull request.
Create pull request.
All changes to the osu! wiki are moderated. During that stage, other collaborators point out possible mistakes and ways to fix them, either in free form, or by suggesting direct edits to the pull request. Just like with any other peer review, you need to address the comments by applying the suggestions, or by explaining why you'd rather keep things your way.
If no one has checked in after a couple of days, try the following:
#osu-wikichannel) or in the GitHub comments.
In addition to a manual review process, the osu! wiki repository has a set of automated checks, which ensure that your changes follow the common style of the wiki and are free from formatting errors. To see their status, open the
Actions tab of your pull request and follow the diagnostic messages under the errors, if there are any.
Your changes will eventually be checked by one of the wiki maintainers, usually after reviews by other collaborators. If nothing happens after a reasonable amount of time, ask in the comments of the pull request, or in the
#osu-wiki channel of the osu!dev Discord server. Your changes will appear on the osu! wiki shortly after the merge (in rare cases, this may take up to five hours).