First off, thank you for considering contributing to WebOsu. It's people like you that makes WebOsu such a great product.
Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue, assessing changes, and helping you finalize your pull requests.
WebOsu is an open source project and we love to receive contributions from our community — you! There are many ways to contribute, from writing tutorials or blog posts, improving the documentation, submitting bug reports and feature requests or writing code which can be incorporated into WebOsu itself. Every little thing helps.
Please, don't use the issue tracker for non-technical questions. Email MostLime directly ([email protected]) or DM him on Discord (mostlime12195). You can also ask and find questions and answers in our GitHub Discussions page.
There are certain responsibilities for contributers:
- Make sure you keep your code compatible for all devices (touchscreen, IOS, PC, etc.) The community can help test certain platforms.
- Format your code neatly and consistently.
- Please give variables clear and understandable names while also using proper naming conventions. See https://curc.readthedocs.io/en/latest/programming/coding-best-practices.html.
- Please remain kind and respectful.
- Keep an open mind and use others' ideas and opinions to improve on your own code.
Unsure where to begin contributing to WebOsu? You can start by looking through these beginner and help-wanted issues: Good first issue - issues which should only require a few lines of code, and a test or two. Help wanted issues - issues which should be a bit more involved than beginner issues. Both issue lists are sorted by total number of comments. While not perfect, number of comments is a reasonable proxy for impact a given change will have.
Is this your first time contributing to an open-sourced project? No problem, we all had a first time. You can learn here: https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github
First, create a fork of our code. Then make as many changes as you'd like to it. Afterwards, test your code to make sure it functions correctly. Once you're all done, you submit a pull request to our master branch! (please make sure the name of your PR follows a the naming convention here). And that's it! As simple as simple could be.
I, MostLime, will review pull requests shortly after they have been submitted. I may provide feedback that I expect you to implement, the pull request may be accepted once changes have been made.
I frequent Discord all the time. Feel free to message me there: mostlime12195 is my username. You can also email me through [email protected].