Skip to content

Clarify integration quality scale expectations for new integrations#3233

Merged
silamon merged 2 commits into
masterfrom
initial_pr_iqs_stricter
Jul 12, 2026
Merged

Clarify integration quality scale expectations for new integrations#3233
silamon merged 2 commits into
masterfrom
initial_pr_iqs_stricter

Conversation

@abmantis

@abmantis abmantis commented Jul 7, 2026

Copy link
Copy Markdown
Member

Proposed change

Emphasize that new integrations must address all bronze level rules, and
reference the "Make your pull request as small as possible" section to
discourage aiming for higher levels in the initial PR.

Type of change

  • Document existing features within Home Assistant
  • Document new or changing features for which there is an existing pull request elsewhere
  • Spelling or grammatical corrections, or rewording for improved clarity
  • Editing or restructuring documentation guidelines
  • Changes to the backend of this documentation
  • Remove stale or deprecated documentation

Checklist

  • I have read and followed the documentation guidelines.
  • I have verified that my changes render correctly in the documentation.

Additional information

  • This PR fixes or closes issue: fixes #
  • Link to relevant existing code or pull request:

Summary by CodeRabbit

  • Documentation
    • Updated the “Integration quality scale” guidance for new Home Assistant Core integrations to require reaching bronze.
    • Added clearer direction to avoid aiming for higher quality levels immediately, to help keep early contributions small and focused.

Emphasize that new integrations must address all bronze level rules, and
reference the "Make your pull request as small as possible" section to
discourage aiming for higher levels in the initial PR.
@coderabbitai

coderabbitai Bot commented Jul 7, 2026

Copy link
Copy Markdown
Contributor

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: a25a8f59-94ef-4fa2-9217-aa56657a492d

📥 Commits

Reviewing files that changed from the base of the PR and between 11f3293 and 4700a62.

📒 Files selected for processing (1)
  • docs/core/integration/contributing_to_core.md
✅ Files skipped from review due to trivial changes (1)
  • docs/core/integration/contributing_to_core.md

📝 Walkthrough

Walkthrough

This change updates the Core integration contributing guide to require new integrations to reach the bronze quality level and to instruct contributors not to target higher levels immediately.

Changes

Core integration contributing guide

Layer / File(s) Summary
Bronze requirement wording
docs/core/integration/contributing_to_core.md
Updates the quality scale guidance to say new integrations must reach bronze and not aim higher right away.

Estimated code review effort: 1 (Trivial) | ~2 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the main documentation change about integration quality expectations.
Description check ✅ Passed The template is mostly filled out, but the checklist is unchecked and the additional information fields are still placeholders.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch initial_pr_iqs_stricter

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

Comment thread docs/core/integration/contributing_to_core.md Outdated
Comment thread docs/core/integration/contributing_to_core.md Outdated
@abmantis abmantis requested a review from joostlek July 7, 2026 17:04
@allenporter

Copy link
Copy Markdown
Contributor

Drive by comment: How I interpreted what was asked for in google health integration was: reach as high as possible given a single platform (e.g. no diagnostics), without adding things that make the PR larger (like reauth). Things like translations, icons, etc are all higher quality things that don't really increase of the initial PR much.

@abmantis

abmantis commented Jul 7, 2026

Copy link
Copy Markdown
Member Author

Drive by comment: How I interpreted what was asked for in google health integration was: reach as high as possible given a single platform (e.g. no diagnostics), without adding things that make the PR larger (like reauth). Things like translations, icons, etc are all higher quality things that don't really increase of the initial PR much.

The existing wording just stated that "It's not required to reach a higher level" because it will "make it harder to review and merge". It can be interpreted as a nudge, but it should be a stronger guideline (since we will likely ask for stuff to be removed from the PR).

@silamon silamon merged commit f5fb98e into master Jul 12, 2026
5 checks passed
@silamon silamon deleted the initial_pr_iqs_stricter branch July 12, 2026 11:53
@allenporter

allenporter commented Jul 12, 2026

Copy link
Copy Markdown
Contributor

Agree on the wording improvement here. Just also saying: in practice we also do ask users to reach a higher levels than bronze if it doesn't make the PR /much/ bigger (e.g. icon translations). Alternatively, just make icon translations bronze.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants