Initial commit

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Discussion Forum
+    url: https://github.com/jensrossbach/esphome-ferraris-meter/discussions
+    about: Please use the forum for asking questions and getting help, providing feedback and discussing new ideas and enhancements.

.github/ISSUE_TEMPLATE/feature-request.md

@@ -0,0 +1,20 @@
+---
+name: Feature Request
+about: Suggest an idea for this project
+title: ''
+labels: enhancement
+assignees: jensrossbach
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/ISSUE_TEMPLATE/problem-report.md

@@ -0,0 +1,33 @@
+---
+name: Problem Report
+about: Create a report to help improve the software
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Logs and configuration**
+If possible, add logs on debug level or higher to help analyze your problem. It could also be helpful to provide the YAML configuration of your ESPHome firmware.
+
+**Context information**
+Please complete the following information.
+ - ESPHome version:
+ - Ferraris Meter version:
+ - Microcontroller type (e.g., ESP32, ESP8266):
+
+**Additional information**
+Add any other information about the problem here.

CONTRIBUTING.md

@@ -0,0 +1,23 @@
+# Contributing to ESPHome Ferraris Meter
+Welcome to the contribution guide of ESPHome Ferraris Meter. 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](https://github.com/jensrossbach/esphome-ferraris-meter/issues). 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](https://www.esphome.io/components/logger.html) 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](https://github.com/jensrossbach/esphome-ferraris-meter/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-ferraris-meter/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.
+
+## 👍 Providing Feedback
+Your comments and feedback are welcome, please share your opinion on the [discussion forum](https://github.com/jensrossbach/esphome-ferraris-meter/discussions/categories/feedback) in the **Feedback** category.

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Jens-Uwe Rossbach
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.