docs: Add the community health files and correct a stale CI note - #22
Merged
Merged
Conversation
Issue forms ask for the diagnostics dump up front, which CONTRIBUTING already calls as valuable as a patch but nothing prompted for. A device report form is separate because the integration detects capabilities at runtime and has only ever been verified on one product line, so a report from other hardware is worth soliciting on its own terms. SECURITY.md documents the unauthenticated callback endpoint rather than waiting to be asked about it. It looks alarming and is deliberate: the device cannot hold a bearer token, so the URL carries 128 bits of secrets.token_hex compared with hmac.compare_digest. CONTRIBUTING claimed ruff was not a required check and that a red ruff job left the merge button live. It has been required for some time.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
1. Issue forms
bug_reportasks for the diagnostics dump, model, firmware and configuration mode up front. CONTRIBUTING already calls a diagnostics dump as valuable as a patch, but nothing prompted anyone for one.device_reportis deliberately separate. The integration detects capabilities at runtime and has only ever been verified on one product line, so a report from other hardware is worth asking for on its own terms, including when everything worked.config.ymlpoints setup and troubleshooting questions at the docs, and vulnerabilities at private reporting rather than a public issue.2. SECURITY.md
Documents the unauthenticated callback endpoint rather than waiting to be asked. It looks alarming and is deliberate: the device cannot hold a bearer token, so the URL carries 128 bits from
secrets.token_hex(16), compared withhmac.compare_digest. Also covers why callback URLs are secrets, why device traffic is plain HTTP, and the device's own access point.Private vulnerability reporting is now enabled on the repo, so the link works.
3. CODE_OF_CONDUCT.md
Contributor Covenant 2.1. Enforcement contact is the maintainer via GitHub rather than an email address, to keep one out of a public file.
4. CONTRIBUTING correction
It claimed branch protection required only
hassfest,HACSandtests, and that a redruffjob still left the merge button live.ruffhas been required for some time. Theminimum HAparagraph is unchanged and still accurate.Testing
All four YAML files parse. No code touched, so the suite is unaffected.