Skip to content

Add a Foundational Principles section stating the model's governing why - #244

Merged
ptr727 merged 5 commits into
developfrom
feature/agents-foundational-principles
Jul 5, 2026
Merged

Add a Foundational Principles section stating the model's governing why#244
ptr727 merged 5 commits into
developfrom
feature/agents-foundational-principles

Conversation

@ptr727

@ptr727 ptr727 commented Jul 5, 2026

Copy link
Copy Markdown
Owner

Documents the governing motivation behind the branch, release, and versioning rules, which were previously captured only as mechanics.

  • Pull vs push distribution grounds release restraint (no release on push, no-op republish, maintainer-gated bumps): a release can reach push-channel users (HACS, main-vendoring consumers) unasked, so it must mark a real functional change, not churn.
  • Dual-target branch sync (Dependabot/codegen hit both develop and main) is what makes the signed + linear + no-backport model possible - forward sync means a develop->main promotion never needs a main->develop back-merge.
  • Two version numbers: the 2-digit major.minor carries human meaning at the maintainer's discretion; NBGV always increments the build.
  • Contracts state what, not how, and favor reuse (the orchestration/build seam).

Placed as a new top section in AGENTS.md so the why is read before the specific rules. References existing sections rather than restating them.

The branch, release, and versioning rules were documented as mechanics without the unifying motivation that governs them. State it up front: pull-vs-push distribution grounds release restraint; dual-target branch sync is what makes the signed/linear/no-backport model possible; the 2-digit version carries human meaning while NBGV guarantees monotonic builds; contracts fix outcomes not implementations and favor reuse.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings July 5, 2026 21:47

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds a new "Foundational Principles" section to AGENTS.md to document the underlying rationale ("why") behind the repo's branching, release, and versioning mechanics so readers see the motivation before the detailed rules.

Changes:

  • Introduces a top-level "Foundational Principles" section describing distribution semantics (pull vs push), dual-branch sync rationale, and the two-version-number model.
  • Adds cross-references to existing sections (e.g., Branching Model, Release Model, WORKFLOW.md) rather than duplicating the full mechanics.

Comment thread AGENTS.md Outdated
Acknowledge PUBLISH_ON_MERGE as an opt-in override to the two-phase default, and that a develop->main promotion is a clean forward merge by default (sync can be broken and restored). Addresses Copilot review.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 2 comments.

Comment thread AGENTS.md Outdated
Comment thread AGENTS.md Outdated
HACS surfaces a pending update to installed users rather than auto-installing a release; say so accurately. Change 'break' to 'breaking change' for list parallelism. Addresses Copilot review.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 1 comment.

Comment thread AGENTS.md Outdated
Match the 'No-op republish guarantee' wording used elsewhere in the file so the phrase greps cleanly. Addresses Copilot review.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 1 comment.

Comment thread AGENTS.md Outdated
Align the Foundational Principles bullet with the 'main -> develop back-merges' / 'forward-only' terminology used in the Branching Model section. Addresses Copilot review.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.

@ptr727
ptr727 merged commit ad63d8f into develop Jul 5, 2026
7 checks passed
@ptr727
ptr727 deleted the feature/agents-foundational-principles branch July 5, 2026 22:00
@ptr727 ptr727 mentioned this pull request Jul 7, 2026
ptr727 added a commit that referenced this pull request Jul 7, 2026
Two-phase promotion of the accumulated governance work on `develop` to
`main`. Carries #244-#251:

- #244 Foundational Principles (the model's governing *why*)
- #245 Replace the mypy ban with a strong-typing policy
- #246 aiopurpleair + homeassistant-purpleair audit reports
- #247 Catalog the 14 backlog repos; add the `eda` type and
`releaseTrigger: none`
- #248 Branch-conditional Docker platforms (multi-arch main, amd64
elsewhere)
- #249 Retire the both-branch matrix for symmetric single-branch
self-release
- #250 Declare workflow YAML as LF and validate line endings in CI
- #251 Extend line-ending governance to pattern files and catalog
snippets

All commits were reviewed and CI-green on their individual develop PRs.
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.

2 participants