Contributing guidelines

When submitting pull requests

Explain your thinking in why a change or addition is needed.
- Is it a requested change or feature?
- If not, open a feature request to get feedback before making a pull request.
Split up multiple unrelated changes in multiple pull requests.
If it's a fix for an unreported bug, make a bug report and link the pull request.
Purely cosmetic changes won't be accepted without a very good explanation of its value.

Formatting

Follow the current syntax design

Indent type: Tabs
Tab size: 4
Opening curly braces { at the end of the same line as the statement/condition.

General guidelines

Don't force a programming style. Use object-oriented, functional, data oriented, etc., where it's suitable.
Use descriptive names for variables.
Use comments if not very obvious what your code is doing.
If using the logger functions, be sensible, only call it if something of importance has changed.
Benchmark your code and look for alternatives if they cause a noticeable negative impact.

License

Code submitted to this project shall fall under the same license as the project.
Any code taken from another existing project should maintain the license that comes with it AND follow the terms of that license.

For questions contact us via discord https://discord.gg/resourcefulbees

For proposing changes to this document create a new issue.