From d67f72f1233068f87b7014411795385decd9e698 Mon Sep 17 00:00:00 2001 From: Magnus Persson Date: Sun, 8 May 2022 09:50:27 +0200 Subject: [PATCH] #6 added contribution --- CONTRIBUTING.md | 33 ++++++++++++++++++++++++++++++++ src_docs/source/contributing.rst | 19 +++++++++++++++++- 2 files changed, 51 insertions(+), 1 deletion(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..1dacbd3 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,33 @@ +## 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. + +#### **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! diff --git a/src_docs/source/contributing.rst b/src_docs/source/contributing.rst index 7472165..16b8a46 100644 --- a/src_docs/source/contributing.rst +++ b/src_docs/source/contributing.rst @@ -1,5 +1,22 @@ Contributing +############ + +Anyone is welcome to contribute to this project or create their own variant of it. I would appreciate a PR if your feature would be of benefit other users. + +In order to keep the source code in good condition I use `pre-commit `_ to validate and format the code using their standards for C++/C. + +If you are using Windows as a base platform I would suggest that you install pre-commit under wsl (Windows Subssytem for Windows) and run it from there, I have found that this approach works fine. + +Design goals ------------ -This section is under construction. +My goals with this software has been the following: +* Create an open software for the excellent iSpindle hardware platform that is open and available for anyone. +* Add user requested features that have not made it into the iSpindle project. +* Focus on long battery life and stability. +* Explore new technologies and create the next generation gravity monitoring for home brewers. + +I will do my best to assist users and respond to new features, pr and suggestions. But keep in mind I'm doing this on my spare time. + +Regards, Magnus