Brewery/gravitymon
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

#6 added contribution

Browse Source
This commit is contained in:
Magnus Persson
2022-05-08 09:50:27 +02:00
parent f09aadaf66
commit d67f72f123
2 changed files with 51 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
src_docs/source/contributing.rst
View File

@ -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 <https://pre-commit.com/>`_ 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