Contributing

One of the goals of UMS Quest is to be expanded upon by members.

So, it is awesome that you are reading this!

This GitHub follows the Contributor Covenant Code of Conduct.

• You want to help? Awesome! See the 'Helping' section
• [Not ready yet] For reporting bugs, see how to report a bug
• For questions, you can create an issue
• [Not ready yet] Code changes go via Pull Requests

Helping

UMS Quest is not perfect. Here are some ways to improve it:

• Help by by playing the game, see How to help as a beta tester
• [Not ready yet] Help by writing code, see How to help as a developer
• Help by improving artwork, see How to help as a graphical artist
• Help by improving sound and music, see How to help as an audio artist

Submitting code

Submitted code should follow these quality guidelines:

• The submitted code makes the game better, where 'better' can mean (1) more game content that is not considered vandalism, (2) positive change to existing game content.
• [Not ready yet] The submitted code is tested 100%
• [Not ready yet] All other tests pass keep passing

Emails with code will not be accepted.

Submitting bugs

Awesome. These are your options:

• Create an issue.
• Submit a pull request, with the failing test, to the main or develop branch
• Send richelbilderbeek an email. richelbilderbeek will make an issue of it

If the report was good enough to reproduce the bug and the bug was not reported yet, you will be mentioned in the acknowledgements.

Branching policy

• The main branch should always build successfully
• The develop branch is for developers