Contributing¶
Awesome that you are reading this.
This GitHub follows the Contributor Covenant Code of Conduct.
- You want to help? Awesome! See the 'Helping' section
- For reporting bugs, see how to report a bug
- For questions, you can create an Issue
- Code changes go via Pull Requests
Helping¶
Conquer Chess is not perfect. Here are some ways to improve it:
- Help by by playing the game, see How to help as a beta tester
- 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 is considered useful
- The submitted code is tested 100%
- All other tests pass keep passing
Emails with code will not be accepted.
Submitting bugs¶
Awesome. These are your options:
- Add an issue, with the test that fails
- Submit a pull request, with the failing test, to the
main
ordevelop
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