Skip to content

Commit 6aab585

Browse files
Create CONTRIBUTING.md
1 parent 5d8f95d commit 6aab585

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

CONTRIBUTING.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Contributing
2+
Also know as how can you help?
3+
4+
## Testing
5+
The vast majority of BTHome properties have been incorporated into the module. But in my projects, I only use a handful of them. Which means many are untested under real-world conditions. If you're using BTHome-MicroPython in a project and something's not quite right, please fill out a bug report in the [GitLab issues](https://github.com/DavesCodeMusings/BTHome-MicroPython/issues).
6+
7+
## Bug Reports
8+
Try to include the following:
9+
* What's not working?
10+
* What is it doing?
11+
* What should it be doing?
12+
* Any ideas to fix it.
13+
14+
For example:
15+
16+
Gas detection is not working. It's returning a 16-bit integer. It should be returning a boolean. I looked in bthome.py and I think the property is mapped incorrectly.

0 commit comments

Comments
 (0)