Extend GitHub Copilot instructions with new learnings from reviews #147652
Conversation
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
There was a problem hiding this comment.
Pull Request Overview
This PR updates the GitHub Copilot instructions with new examples and guidelines that incorporate recent review learnings. The changes include:
- Updating the coordinator’s init signature to include the config_entry parameter.
- Providing clearer examples and best practices for try/catch blocks, polling intervals, and lambda formatting.
- Clarifying rules for config entry naming and user-configurable polling intervals.
Comments suppressed due to low confidence (2)
.github/copilot-instructions.md:99
- Ensure that adding the config_entry parameter is consistently propagated in all coordinator subclasses and that related documentation is updated accordingly.
def __init__(self, hass: HomeAssistant, client: MyClient, config_entry: ConfigEntry) -> None:
.github/copilot-instructions.md:949
- [nitpick] Clarify in the documentation that user-configurable polling intervals are disallowed, ensuring a clear distinction between allowed and disallowed configurations.
vol.Optional("scan_interval", default=60): cv.positive_int # ❌ Not allowed
joostlek
approved these changes
Jun 27, 2025
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Proposed change
After running GitHub Copilot reviews on a bunch of pull request, I've noticed room for improvement. Additionally, processed some comments from @joostlek on Discord.
Type of change
Additional information
Checklist
ruff format homeassistant tests)If user exposed functionality or configuration variables are added/changed:
If the code communicates with devices, web services, or third-party tools:
Updated and included derived files by running:
python3 -m script.hassfest.requirements_all.txt.Updated by running
python3 -m script.gen_requirements_all.To help with the load of incoming pull requests: