gravitymon/CONTRIBUTING.md
2022-05-08 09:50:45 +02:00

36 lines
1.9 KiB
Markdown

## How to contribute to GravityMon
#### **Did you find a bug?**
* **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/mp-se/gravitymon/issues). Dont forget to look under closed issues. There might be a fix but not yet included in the released version.
* If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/mp-se/gravitymon/issues/new). Be sure to include a **title and clear description**, as much relevant information as possible, Use the function on the device to extract configuration and device information (does not contain any sensitive data). This can help to pinpoint the issue.
#### **Did you write a patch that fixes a bug?**
* Open a new GitHub pull request with the patch.
* Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.
* Before submitting, please use `pre-commit` to validate that your code contribution complies with the formatting standards for C++ and C.
* Check the contribution section under the documentation for additional information.
#### **Do you intend to add a new feature or change an existing one?**
* Suggest your change in the [Discussion forums](https://github.com/mp-se/gravitymon/discussions) and start writing code.
* Do not open an issue on GitHub until you have collected positive feedback about the change. GitHub issues are primarily intended for bug reports and fixes.
#### **Do you have questions about the source software?**
* Start a discussion in the [Discussion forums](https://github.com/mp-se/gravitymon/discussions) and start writing code.
#### **Do you want to contribute to the documentation?**
* Open a new GitHub pull request with the updated documentation changes.
* Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.
Thanks!