Contributing code

We welcome contributions from people of all different interests, skill levels and backgrounds!

We do our best to be friendly and helpful to everyone who wants to help make Rabbit Escape better - feel free to experiment and chat with us, and have fun. We all frequently make mistakes and have terrible ideas, so don't worry if you think you might do the same!

The way we normally interact is by creating GitHub issues. Feel free to create a new issue if you have an idea, a question, bug report, or want to start a conversation.

Side note: please let us know if we don't succeed in being welcoming, constructive and friendly, or if someone in our community is acting in a threatening or excluding way. You can do that via GitHub issues or by emailing Andy Balaam on rabbitescape@artificialworlds.net.

Compiling

You can find out how to compile the code in INSTALL.md.

If you're working on a pull request, when you think it's ready to be merged, make sure you do:

make clean slowtest

This will make sure the code compiles with no warnings or errors, so that if your pull request is merged you won't break anyone else's build. In our build, warnings are errors, but they may not be in your IDE, so you may miss some.

If you need to write code that triggers compile warnings, you can use the @SuppressWarnings annotation to suppress them, but you should expect to be asked why we need to do this!

Make targets

• make test: runs the unit tests only
• make slowtest: does a full system test, running the real game in text mode and checking it works