Skip to content

Commit

Permalink
Add support, contributing and known issues to table of contents
Browse files Browse the repository at this point in the history
  • Loading branch information
jensrossbach committed Oct 4, 2024
1 parent aafb3be commit 364b24e
Show file tree
Hide file tree
Showing 3 changed files with 40 additions and 1 deletion.
28 changes: 27 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,29 @@
# Mitwirkung bei ESPHome Luxtronik V1
Willkommen beim Leitfaden zur Mitarbeit an ESPHome Luxtronik V1. Es gibt viele Möglichkeiten, einen Beitrag zu leisten: Fehler melden, neue Funktionen vorschlagen oder Feedback geben.

## 🐞 Probleme melden
Wenn du auf einen Fehler oder ein anderes Problem gestoßen bist, kannst du gerne einen **Problem Report** im [Ticket-System](https://github.com/jensrossbach/esphome-luxtronik-v1/issues) erstellen. Bevor du einen Problembericht erstellst, prüfe bitte, ob das Problem bereits von jemand anderem gemeldet wurde. Wenn dies der Fall ist, füge bitte einen Kommentar zu dem bestehenden Problem hinzu, in dem du die Details deines Problems beschreibst (je genauer die Problemberichte sind, desto besser können sie voneinander unterschieden werden, um Duplikate zu identifizieren).

Bitte fasse nicht mehrere Probleme in einem Ticket zusammen, sondern erstelle ein Ticket pro Problem. Versuche, deine Problembeschreibung so genau wie möglich zu formulieren. Es ist immer hilfreich, wenn du Protokolle (mindestens im Detailgrad "debug") zur Verfügung stellst. Schlage in der ESPHome-Dokumentation der [Logger-Komponente](https://www.esphome.io/components/logger.html) nach, wenn du nicht weißt, wie du Protokolle erstellen und den Protokoll-Detailgrad konfigurieren kannst. Du kannst Protokolle über die Befehlszeile mit dem folgenden Befehl aufzeichnen:

```
esphome logs <your_config.yaml>
```

Es könnte auch hilfreich sein, die YAML-Konfiguration deiner ESPHome-Firmware bereitzustellen. Vergiss aber nicht, alle datenschutz- und sicherheitsrelevanten Informationen (z.B. Passwörter) zu entfernen oder verwende `secrets.yaml`, bevor du die Datei hochlädst.

Bitte verwende immer die Vorlage für Problemberichte im Ticket-System, da diese einige vorausgefüllte Hinweise darauf enthält, welche Informationen du in deinem Ticket angeben solltest.

## 💡 Neue Funktionalität anfragen
Falls du eine neue Funktion benötigst oder der Meinung sind, dass eine bestehende Funktion geändert werden muss, diskutiere bitte zuerst deine Idee im [Diskussionsforum](https://github.com/jensrossbach/esphome-luxtronik-v1/discussions/categories/ideas) in der Kategorie **Ideas**. Wenn der Konsens ist, dass diese Idee es wert ist, umgesetzt zu werden, dann erstelle einen **Feature Request** oder einen **Change Request** im [Ticket-System](https://github.com/jensrossbach/esphome-luxtronik-v1/issues).

Bitte verwende immer die Vorlage für Funktionsanfragen im Ticket-System, da diese einige vorausgefüllte Hinweise darüber enthält, welche Informationen du in deiner Anfrage angeben solltest.

## 👍 Feedback geben
Deine Kommentare und dein Feedback sind willkommen. Bitte teile deine Meinung im [Diskussionsforum](https://github.com/jensrossbach/esphome-luxtronik-v1/discussions/categories/feedback) in der Kategorie **Feedback** mit.

-----

# Contributing to ESPHome Luxtronik V1
Welcome to the contribution guide of ESPHome Luxtronik V1. There are many ways to contribute like reporting bugs, proposing new features or providing feedback.

Expand All @@ -15,7 +41,7 @@ It could also be helpful to provide the YAML configuration of your ESPHome firmw
Please always use the Problem Report template in the issue tracker as it provides some prefilled hints about which information you should provide in your report.

## 💡 Requesting Features
In case you need a new feature or think that some existing functionality requires modifications, please first discuss your idea on the [discussion forum](https://github.com/jensrossbach/esphome-luxtronik-v1/discussions/categories/ideas) in the **Ideas** category. If the consensus is that this idea is worth being implemented, then and only then create a **Feature Request** in the [issue tracker](https://github.com/jensrossbach/esphome-luxtronik-v1/issues).
In case you need a new feature or think that some existing functionality requires modifications, please first discuss your idea on the [discussion forum](https://github.com/jensrossbach/esphome-luxtronik-v1/discussions/categories/ideas) in the **Ideas** category. If the consensus is that this idea is worth being implemented, then and only then create a **Feature Request** or a **Change Request** in the [issue tracker](https://github.com/jensrossbach/esphome-luxtronik-v1/issues).

Please always use the Feature Request template in the issue tracker as it provides some prefilled hints about which information you should provide in your request.

Expand Down
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,9 @@ Dieses Projekt wurde stark von der [Luxtronik V1 ESPHome-Komponente](https://git
- [Binäre Sensoren](#binäre-sensoren)
- [Textsensoren](#textsensoren)
- [Luxtronik-Konfiguration](#luxtronik-konfiguration)
- [Hilfe/Unterstützung](SUPPORT.md)
- [Mitwirkung](CONTRIBUTING.md)
- [Bekannte Probleme](https://github.com/jensrossbach/esphome-luxtronik-v1/issues?q=is%3Aissue+is%3Aopen+label%3A%22known+issue%22)

## Haftungsausschluss
**DIESE SOFTWARE UND DEREN AUTOR STEHEN IN KEINER VERBINDUNG ZU AIT / ALPHA INNOTEC.**
Expand Down Expand Up @@ -380,6 +383,9 @@ This project was heavily inspired by the [Luxtronik V1 ESPHome component](https:
- [Binary Sensors](#binary-sensors)
- [Text Sensors](#text-sensors)
- [Luxtronik Configuration](#luxtronik-configuration)
- [Help/Support](SUPPORT.md#-getting-support-for-esphome-luxtronik-v1)
- [Contributing](CONTRIBUTING.md#contributing-to-esphome-luxtronik-v1)
- [Known Issues](https://github.com/jensrossbach/esphome-luxtronik-v1/issues?q=is%3Aissue+is%3Aopen+label%3A%22known+issue%22)

## Disclaimer
**THIS SOFTWARE AND ITS AUTHOR ARE NOT AFFILIATED WITH AIT / ALPHA INNOTEC.**
Expand Down
7 changes: 7 additions & 0 deletions SUPPORT.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
# 🙏 Unterstützung für ESPHome Luxtronik V1 erhalten
Du hast eine Frage oder brauchst Hilfe? Kein Problem! Aber anstatt ein Ticket zu eröffnen, frage bitte im [Diskussionsforum](https://github.com/jensrossbach/esphome-luxtronik-v1/discussions/categories/q-a) in der Kategorie **Q&A**. Ich werde versuchen, deine Frage so schnell wie möglich zu beantworten.

Wenn du bereits mit der Software vertraut bist, zögere nicht, andere zu unterstützen, indem du deren Fragen beantworten.

-----

# 🙏 Getting support for ESPHome Luxtronik V1
Have a question or need help? No problem! But rather than opening an issue, please ask away on the [discussion forum](https://github.com/jensrossbach/esphome-luxtronik-v1/discussions/categories/q-a) in the **Q&A** category. I will try to answer your question as soon as possible.

Expand Down

0 comments on commit 364b24e

Please # to comment.