Contributing

If you plan on contributing, please follow the guidelines below.

1. Please make sure you have the latest version of OpenMaze on your machine and are able to edit the underlying code. While any text editor works for this step, we recommend you use Rider from JetBrains since Unity and C# integrations are provided that make the project much easier to work with.
2. Contact us at duncanlabuoft@gmail.com with the subject "Request for push access to OpenMaze project" with some information about the kind of changes you are looking to make to OpenMaze. If you prefer to modify OpenMaze on your own, fork it before continuing.
3. Create your feature branch (git checkout -b feature/fooBar).
4. Make sure to increase the version of any relevant files to the version that your pull request would represent. We make use of SemVer for versioning.
5. Commit your changes (git commit -am 'Added some amazing features').
6. Update any documentation on the wiki with information about your awesome new features and let us know if your changes impact the OpenMaze API so that we can update the website accordingly.
7. Push to your branch (git push origin feature/fooBar).
8. Create a new Pull Request. You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.

If you have any questions about the process, feel free to reach out to us!