Thank you for your interest in contributing to Modot! Any contribution, big or small, is appreciated, and goes a long way towards making Modot a more usable and robust framework.
stableis the default branch. Nothing is directly committed tostable- instead, commits are merged from other branches into it.developmentis the feature branch. Most changes and new additions are either committed into this branch or merged from other branches or forks, before being merged intostable.csharpandgdscriptare the branches for Modot's C# and GDScript versions respectively. Development specific to either of these versions takes place in these branches.
If you spot bugs or otherwise unintended behaviour in Modot, you are welcome to open a new issue using the relevant template. Don't forget to include a clear description of the issue and context where applicable.
If you find an existing issue you would like to work on, feel free to open a pull request with a fix for it. Don't forget to inform other contributors of your decision, to prevent multiple contributors working separately on the same issue at the same time.
You can fork the repository and make any new changes or additions on the forked versions. If the contribution is related to a bugfix or feature request, it is recommended to open a related issue to inform users and other contributors of progress towards it.
When you are finished with any new additions or changes, open a pull request. Include a clear and detailed list of all changes, as well as links to relevant issues if applicable.
Also enable the checkbox for maintainer edits to your pull request. This allows maintainers to suggest additional changes or revisions to your pull request if necessary.
Finally, don't forget to resolve related conversations and issues once your pull request has been merged.
- Branch names should be
kebab-case. - Commits should be capitalized and use the imperative tone.
Use the rules defined in the provided .editorconfig file.