CONTRIBUTING.md

Contributing

Project Structure

TODO

Documentation

This project uses MKDocs to serve all docs. You can change the documentation inside the docs folder. Install mkdocs via pip install mkdocs. Serve the docs via mkdocs serve. To add new pages you need to update mkdocs.yml.

Preparing your PR

The project is using clang-format to format most files. You need to run bash ./clang_format.sh before your PR for a successful pipeline.

Furthermore, there is an utf-8 and LF checker to fix file formats. Additionally, some spellchecks run inside the pipeline.

Release library

As a maintainer you are able to create a new release.

1. Go to create new release
2. Next you should Choose a tag and create a new one in the format v0.0.0
3. Select target master
4. Click Generate release notes
5. (Optional) You can edit the generated release notes
6. Add a release title in the format [Tag]-alpha-[Year][Month][Day] as an example v0.0.17-alpha-20231003. The used godot version will be added ass prefix automatically
7. Press Publish release