search

osucord / resources

GNU General Public License v3.0
5 stars 8 forks source link

readme

osu! Game Resources

This repository contains a curated list of links to various resources for osu! game. The resources are categorized into different sections and are maintained by the community.

The list is open for contributions from anyone. If you have a resource that you think should be added to the list, you can do so by following the instructions below.

The list

The website is available at: https://resources.osucord.moe/

This list is also displayed in the #osu-resources channel on the osu! Game Community Discord server for everyone to see.

Maintenance

We have a system in place that checks all the resources in the list daily to notify us about potentially broken links so we could promptly fix or remove them. Any links submitted as a pull request will also be checked automatically to make sure broken links are not added by accident.

If you find that there are broken links despite that, resources that are no longer functional, or links that lead to something else than what is described next to them - please create an issue.

How to contribute

If you are unfamiliar with how GitHub works, you can contribute by following these steps:

  1. Create a GitHub account in case you don't have one yet, then log in.
  2. At the top of this page, click on the Fork button.

This will create a copy of this repository in your account. You can now make changes to the contents of this repository:

  1. Navigate to the forked repository in your account and press the . (period) key on your keyboard. This will open the repository in an online editor.
  2. Make changes to the content.md file. You can add new resources or modify existing ones to give them better descriptions.

If you decide to close the page, the changes you made will be saved as in browser and you can continue editing them later.

Once you are done with your changes, you have to commit them to the repository:

  1. On the left, find the "Source Control" button (it should have a number next to it indicating uncommitted changes) and click on it.
  2. You will see a list of files that you have changed. You can review the changes by clicking on the file names.
  3. At the top of the source control panel - write a message that describes the changes you made.
  4. Press the Commit & push button. This will save your changes to your repository.

You can continue making changes to your repository and commit them as many times as you want. It's a good idea to make changes in batches that make logical sense together and commit them as a single change.

At this point, the changes are only in your personal repository. To submit them to the main repository you have to create a pull request:

  1. In the same source control panel, at the top - find and click the Create Pull Request button.
  2. Give your pull request a title and a description that explains what changes you made.
  3. Press the Create button.

That's it! The maintainers of the repository will review your changes and approve them as soon as possible. After merging them into the main repository, your changes will be visible to everyone on the Discord server shortly. We appreciate the contribution.

What resources can be added?

You can add any resource you believe would be useful for the osu! community. This includes, but is not limited to:

Your contributions may be rejected if:

Acknowledgments

This list has been created and is currently primarily maintained by the staff of the osu! Game Community Discord server, with contributions from our community. The list of users who have directly contributed to this repository can be found here.

Parts of the list have been adapted from: