Skip to content

Latest commit

 

History

History
23 lines (15 loc) · 2.5 KB

CONTRIBUTING.md

File metadata and controls

23 lines (15 loc) · 2.5 KB

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.

🐞 Reporting Problems

If you encountered a bug or other problem, you are welcome to create a Problem Report in the issue tracker. Before creating the issue, please check if the problem has already been reported by someone else. If so, instead of entering a duplicate issue, please add a comment to the existing issue telling about the details of your problem (the more precise the problem reports are, the better they can be distinguished from each other in order to identify duplicates).

Please do not collect multiple problems in one issue, but instead enter one issue per problem. Try to be as precise as possible with your problem description. It is always helpful if you provide logs on debug level or higher. Refer to the ESPHome documentation of the logger component if you do not know how to create logs and how to configure the log level. You can record logs from the command line using the following command:

esphome logs <your_config.yaml>

It could also be helpful to provide the YAML configuration of your ESPHome firmware. But don't forget to remove any privacy and security related data (e.g., passwords) or make use of secrets.yaml before uploading the file.

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 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.

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.

👍 Providing Feedback

Your comments and feedback are welcome, please share your opinion on the discussion forum in the Feedback category.