From d88c99cbb7127419b894f052a63b49ea95a59bd7 Mon Sep 17 00:00:00 2001 From: Stefan Allius <122395479+s-allius@users.noreply.github.com> Date: Mon, 25 Sep 2023 21:39:01 +0200 Subject: [PATCH] Create CONTRIBUTING.md --- CONTRIBUTING.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..5de5b0c --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,19 @@ +# Contributing to 'TSUN Gen3 Proxy' + +:+1::tada: First off, thanks for taking the time to contribute! :tada::+1: + +The project aims to bring TSUN third generation inverters (with WiFi support) into local home automation as easily as possible. In some forums the wish was expressed again and again for a solution that keeps the data locally and is not in the cloud. So far I have not found a corresponding solution, and therefore started this project. + +The code base of the proxy was created in a few weeks after work and offers many possibilities for collaboration. + +Especially in the area of +- docker compose +- packaging +- test automation +- documentation + +I would be very happy about support. But also [issue](https://github.com/s-allius/tsun-gen3-proxy/issues) reports and [discussions](https://github.com/s-allius/tsun-gen3-proxy/discussions) are welcome. + +There is only one rule, our [code of conduct](https://github.com/s-allius/tsun-gen3-proxy/blob/main/CODE_OF_CONDUCT.md). + +Cheers, Stefan Allius