- Suggesting changes or new features via issues that adhere to the guidelines below.
- Reporting bugs or quirks via issues that adhere to the guidelines below.
- Submitting pull requests that adhere to the guidelines below.
Issues should:
-
Be a bug, feature, or question
Discussions or otherwise non-issues should be directed to discussions. Questions are also better suited for discussions.
-
Have a well-defined scope
Similar to StackOverflow, an issue should be focused on one bug, feature, or question. Split them into multiple issues when possible.
-
Be descriptive
It is strongly reccomended that issues abide by our issue templates. Otherwise, an issue should contain any relevant information, such as the referenced code, logs (if possible), and stack traces.
Branches tied to development for a certain issue are to be named "<username>/issue/<issue-number>".
In almost every case, pull requests should be connected to a specific issue. It is strongly reccomended that your changes do not exceed the scope of the target issue. This is evident when unrelated systems are changed, and should discussed in a separate issue.
Code formatting rules should more or less be defined in the editorconfig.
Unit tests should reflect any changes made in pull requests. This includes source generators to a lesser extent, where the tested code is very volatile.
Modification and creation of features should be reflected in the documentation.