docs: unpin the branch-pinned CONTRIBUTORS.md links in the PR template - #1879
Conversation
The v1 maintenance policy was stated two different ways across the docs — "security fixes only" in CONTRIBUTORS.md, "bug fixes" in README.md. The #1819 PR triage told 120 contributors that v1 is security-fixes-only, so that is the wording we keep. Also make the PR template's two CONTRIBUTORS.md links relative instead of pinned to blob/main/. `main` is release-only, so those resolved against the last released tree rather than the branch the reader is on. The remaining AGENTS.md occurrences are left alone deliberately: PR #1866 rewrites those exact lines and lands first. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01YAt8rqxysNbhYWLhoRm3fU
There was a problem hiding this comment.
Pull request overview
This PR makes small, targeted documentation adjustments to (1) standardize the v1 maintenance-policy wording and (2) fix PR-template links so they don’t point at a branch-pinned blob/main/... path.
Changes:
- Updates the README “Repo status” callout to use “security fixes only” wording for the v1 line.
- Converts PR template links to
CONTRIBUTORS.mdfromblob/main/...to relative paths so they follow the branch being viewed.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| README.md | Updates the v1 policy wording in the repo-status callout. |
| .github/pull_request_template.md | Replaces blob/main-pinned links with relative paths to CONTRIBUTORS.md. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ``` | ||
|
|
||
| > **Repo status.** This is the **v2** line of the Inspector (branch `v2/main`). The `main` branch is the legacy v1 implementation (bug fixes only). v2 will eventually replace `main`. See [`AGENTS.md`](./AGENTS.md) for branch/board conventions. | ||
| > **Repo status.** This is the **v2** line of the Inspector (branch `v2/main`). The `main` branch is the legacy v1 implementation (security fixes only). v2 will eventually replace `main`. See [`AGENTS.md`](./AGENTS.md) for branch/board conventions. |
There was a problem hiding this comment.
Good catch, and you're right that the callout is factually stale — but I'm deliberately not fixing it here. The "Repo status" prose (which branch is which, and the v1 maintenance policy sentence) is owned by open PR #1866, which rewrites exactly that material and merges before this one. Rewording it in two places at once would produce contradictory text plus a merge conflict for zero benefit.
This PR's remaining scope is the .github/pull_request_template.md half: unpinning the two blob/main/CONTRIBUTORS.md links so they're relative and follow whatever branch the reader is on. The README/AGENTS.md wording reconciliation, including the main vs. v1/main correction you're pointing at, is being handled on #1866's branch.
cliffhall
changed the title
The "Repo status" callout edit here patched `(bug fixes only)` → `(security fixes only)` on the callout as it exists on v2/main. But #1866 replaces that entire callout, because the surrounding sentence is false today: it still says "The `main` branch is the legacy v1 implementation", when `main` now holds the latest released v2. So this edit both collides with #1866 on the same line and, taken on its own, would preserve the false statement while correcting only the parenthetical. #1866 already sets the v1 policy wording to "security fixes only" across AGENTS.md and README (ee020ff), so nothing is lost by dropping it here. This PR is now exactly its intended half: the two branch-pinned `blob/main/CONTRIBUTORS.md` links in .github/pull_request_template.md, made relative. That file is untouched by #1866, so the two PRs no longer overlap on any line. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01YAt8rqxysNbhYWLhoRm3fU
|
Dropped the The overlap check that concluded "#1866 changes only AGENTS.md and .github/copilot-instructions.md" was incorrect — #1866 touches four files including
Nothing is lost: #1866's |
…e policy (#1884) * docs: rename CONTRIBUTORS.md to CONTRIBUTING.md (#1883) GitHub's contributing-guidelines banner — shown when someone clicks "New issue" or opens a pull request — keys on the exact filename CONTRIBUTING.md. Naming the file CONTRIBUTORS.md left that prompt dark precisely where the "open an issue, not a PR" policy needs to land. Renamed with `git mv` so history follows the file; contents are unchanged (its heading already reads "Contributing to MCP Inspector"). Updated the one in-repo reference, in AGENTS.md. The two links in .github/pull_request_template.md are deliberately untouched — PR #1879 makes them relative so they follow the rename. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01YAt8rqxysNbhYWLhoRm3fU * docs: drop the AGENTS.md link edit; #1866 owns that line This PR edited the `See [CONTRIBUTORS.md](./CONTRIBUTORS.md)` link in AGENTS.md, which is the exact line #1866 rewrites — guaranteeing a one-line conflict when this merges after it. Handing that line to its owner instead: #1866 now writes the link as `CONTRIBUTING.md` directly, so this PR is a pure `git mv` and the two touch no common line. No conflict to resolve at merge time. The tradeoff is a short window between the two merges where AGENTS.md links to a filename that doesn't exist yet. That's deliberate and bounded: #1866 is first in the merge order and this is third. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01YAt8rqxysNbhYWLhoRm3fU --------- Co-authored-by: Claude Opus 5 (1M context) <noreply@anthropic.com>
Closes #1813
Branch-pinned PR-template links
.github/pull_request_template.mdlinked toCONTRIBUTORS.mdtwice, both pinned toblob/main/:[CONTRIBUTORS.md](../blob/main/CONTRIBUTORS.md)mainis release-only, so those resolved against the last released tree rather than the branch the reader is on — and they'd break outright whenCONTRIBUTORS.mdis renamed (#1821) until a milestone merge carries the new name tomain.Both are now relative (
../CONTRIBUTORS.md, relative to.github/), so they follow whatever branch is being read rather than being repointed at another fixed branch.Conflict avoidance
Everything touched here is outside #1866's diff — that PR changes
AGENTS.mdand.github/copilot-instructions.mdonly. The fourAGENTS.mdlocations listed in #1813's table are all inside #1866's rewrite (three of them don't exist onv2/mainyet), andCONTRIBUTORS.md:54already read "security fixes only", so neither file is touched here.Testing
Docs-only. No format/lint/typecheck/coverage gate covers
.md(theformat:checkglobs are source-extension only), and no code paths are touched.