Decouple verbatim-carry runbook, clarify versioning, list downstreams - #156
Merged
Conversation
Resolves#155: keep .github/copilot-instructions.md self-contained so a verbatim carry into a conforming derived repo leaves no dangling AGENTS.md anchors or template-only claims (drop the pre-carry blockquote, retarget non-mandated cross-refs, remove the template-specific versioning paragraph). Replace the mandatory 'develop leads main by a minor' / post-release bump-version policy with semantic, maintainer-driven version.json bumps; develop builds are always prereleases so they need no artificial lead. Add a Known Downstream Projects catalog to AGENTS.md so template-side contract changes can be filed as heads-up issues downstream, and make the upstream/downstream sync explicitly bidirectional.
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the template's cross-cutting contract documentation so .github/copilot-instructions.md remains safe as a verbatim-carry artifact in derived repos, clarifies the intended versioning workflow, and adds a maintained catalog of downstream projects to make sync explicitly bidirectional.
Changes:
- Decouples
.github/copilot-instructions.mdfrom non-mandatedAGENTS.mdanchors and retargets the upstream reference for derived repos. - Updates versioning guidance to be maintainer-driven (bump
version.jsononly when functional changes warrant it; no mechanical post-release bump). - Adds a "Known Downstream Projects" table and references it from README to improve downstream notification on contract changes.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| README.md | Updates template setup checklist and branching/versioning guidance; points adopters to the downstream catalog. |
| AGENTS.md | Clarifies versioning rules in the Release Model and adds a downstream-projects catalog under Staying in Sync. |
| .github/copilot-instructions.md | Removes template-only assumptions and ensures links only rely on the mandated PR Review Etiquette anchor; points upstream for template-only sections. |
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
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 freeto 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.
Summary
Three related template-contract fixes surfaced while re-syncing
ptr727/NxWitness(NxWitness#439).1. Resolve#155 — keep
.github/copilot-instructions.mdcarry-safe (Option 2: decouple)The mandated whole-file verbatim carry embedded template-only assumptions that broke once carried into a conforming derived repo (whose only mandated AGENTS.md section is PR Review Etiquette):
#release-modeldangling anchor).<owner>/<repo>/<N>blockquote with a clean runbook-purpose line (clears the#files-and-sections…dangling anchor).Every remaining local
../AGENTS.md#anchor now resolves only to the mandated#pr-review-etiquette.2. Clarify versioning — remove the mandatory develop lead / post-release bump
version.jsonis now bumped only for functional changes, by maintainer instruction, not mechanically after a release.developbuilds are always prereleases, so they need no artificial minor lead and there is nobump-version-X.YPR orgit checkout main -- version.jsontrick. Updated AGENTS.md Release Model and the README branching bullet.3. Add a Known Downstream Projects catalog
New table in AGENTS.md Staying in Sync (NxWitness, PlexCleaner, Utilities, LanguageTags, ESPHome-NonRoot, VSCode-Server-DotNetCore, homeassistant-purpleair) with each repo's consumer model, plus the maintainer-facing direction to file heads-up issues downstream on contract changes — making the sync explicitly bidirectional. README points adopters to it and reinforces filing upstream issues.
Verification