wiki

osu! wiki contribution guide

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.

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.

Areas of interest

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.

Editing the wiki

For a generalised contribution process, see GitHub flow - GitHub Docs

The osu! wiki articles are stored on GitHub. To contribute, do the following:

  1. Create a GitHub account.
  2. Open the ppy/osu-wiki repository and click Fork in the top-right corner to make a controlled copy of the wiki. To return to your fork, go to ppy/osu-wiki and press Fork again.
  1. Read Best practices § Making changes and perform necessary edits. While you are free to use any application of your choice, the osu! wiki has detailed instructions on two workflows:

Self-check

When you are done editing, take some time to proofread your work. Go through the following quick checklist:

  • Tone of delivery: the osu! wiki articles, with rare exceptions, must be written using a neutral register.
  • Style and grammar: the articles should be clear, understandable, and require no significant mental effort from the reader. Be consistent and avoid overcomplicated or abrupt sentences. Use editors with built-in spell checkers, such as Google Docs, to expose typos and grammatical or syntax errors.
  • Content parity: translations must contain the same information as the original articles (differences in punctuation, wording, or formatting are obviously expected). Instead of changing the contents of the translation, open an issue or an extra pull request for the original if you feel it is incomplete, inaccurate, or outdated.
  • Structure and formatting: preview your article with a tool such as jbt's Markdown Editor to make sure it looks exactly how you wanted it to be.
  • All images and other non-text files must be under 1 megabyte. Screenshots need to use the default osu! skin and specific settings, including the maximum dimensions of 1280×720.

For a complete list of rules, read the article styling criteria.

Pull request

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:

  1. In your fork of the osu! wiki, find the dropdown which says master↓, and select the branch with your changes.
  2. Click the Contribute↓ button and select Open pull request.
  3. Fill in the details according to Best practices § Opening a pull request and click Create pull request.

Review

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:

  • Make sure you have resolved all suggestions—people may be waiting on your responses.
  • Ask other osu! wiki editors in the osu!dev Discord server (#osu-wiki channel) or in the GitHub comments.
  • To get help with the translation, check a couple of merged pull requests for your language and get in touch with their reviewers and/or authors (example GitHub query).
  • Ask your friends for a quick look!

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.

Merge

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).