Skip to content

Commit 4d32c2d

Browse files
committed
docs: address Copilot review on the issue forms (#1844)
- PR template said `v2` targets `main`; the v2 base branch is `v2/main`. Correct on its face, and the one line in that template a reader acts on. - Scoped the Node floor on the bug form to v2, since the form serves both lines and v1's floor is older — reading `>= 22.19.0` as universal would make a legitimate v1 report look out of support. - Both the CONTRIBUTING.md paragraph and the AGENTS.md section now say the chooser is served from the **default branch**, so neither claims a form added on `v2/main` is live before the milestone merge.
1 parent e67ff31 commit 4d32c2d

4 files changed

Lines changed: 9 additions & 4 deletions

File tree

‎.github/ISSUE_TEMPLATE/1-bug_report.yml‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,9 @@ body:
5858
id: node-version
5959
attributes:
6060
label: Node version
61-
description: Output of `node --version`. The Inspector requires Node >= 22.19.0.
61+
description: >
62+
Output of `node --version`. The current v2 line requires Node >=
63+
22.19.0; the deprecated v1 line has its own, older floor.
6264
placeholder: "v22.19.0"
6365
validations:
6466
required: true

‎.github/pull_request_template.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
1212
If you've found a bug or want a feature:
1313
→ Open an issue instead, labeled for the version you're targeting
14-
(`v1` for `v1/main`, `v2` for `main`).
14+
(`v1` for `v1/main`, `v2` for `v2/main`).
1515
1616
If you've already built the change locally:
1717
→ Open an issue and share the PROMPT(S) you used to generate it, not a

‎AGENTS.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ If you've already built a change locally, share the **prompt** you used and scre
120120

121121
**This applies to org members with write access too, not just outside contributors.** Having permission to push a branch is not authorization to open a PR. Pull requests against this repo are opened by the **repo maintainers** only. Anyone else — including organization members whose write access makes it technically possible — opens a **detailed issue** instead, and a maintainer takes it from there. A detailed issue means: the problem, how to reproduce it, the behavior you expected, and — if you've already prototyped a fix — the prompt you used and any screenshots, rather than a diff.
122122

123-
**Issues are filed through the forms in [`.github/ISSUE_TEMPLATE/`](./.github/ISSUE_TEMPLATE) — blank issues are disabled.** There are two forms, **Bug report** (`1-bug_report.yml`, auto-labels `bug`) and **Feature request** (`2-feature_request.yml`, auto-labels `enhancement`); `config.yml` holds the chooser's contact links. Neither form applies a `v1`/`v2` label — the version line is a required *dropdown*, since GitHub can't map a form answer to a label, so a maintainer still applies the version label at triage per [Label by version](#issue-driven-work-style). **There is deliberately no security template**: a vulnerability report must not open a public issue, so the chooser routes it to the private advisory form as a contact link instead (see [`SECURITY.md`](./SECURITY.md)). When adding or changing a form, validate it against GitHub's issue-forms schema (`markdown` blocks take no `id` and no `validations`; `checkboxes` mark `required` per option, not under `validations`).
123+
**Issues are filed through the forms in [`.github/ISSUE_TEMPLATE/`](./.github/ISSUE_TEMPLATE) — blank issues are disabled.** GitHub serves the chooser from the **default branch** only, so a form edited here on `v2/main` has no effect on the live chooser until the next milestone merge into `main` — and it cannot be previewed before then, which is why the schema notes below matter. There are two forms, **Bug report** (`1-bug_report.yml`, auto-labels `bug`) and **Feature request** (`2-feature_request.yml`, auto-labels `enhancement`); `config.yml` holds the chooser's contact links. Neither form applies a `v1`/`v2` label — the version line is a required *dropdown*, since GitHub can't map a form answer to a label, so a maintainer still applies the version label at triage per [Label by version](#issue-driven-work-style). **There is deliberately no security template**: a vulnerability report must not open a public issue, so the chooser routes it to the private advisory form as a contact link instead (see [`SECURITY.md`](./SECURITY.md)). When adding or changing a form, validate it against GitHub's issue-forms schema (`markdown` blocks take no `id` and no `validations`; `checkboxes` mark `required` per option, not under `validations`).
124124

125125
**Every PR must reference an issue. No exceptions, regardless of who opens it.** The PR body's first line is `Closes #<ISSUE_NUMBER>` (see the [Issue-driven Work Style](#issue-driven-work-style) rules below). A PR with no linked issue has no board card, so the work is invisible to the project board and untracked — if you're about to open one and there's no issue yet, create the issue first. This holds for a maintainer's own one-line fix as much as for a feature.
126126

‎CONTRIBUTING.md‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,10 @@ and implementation.
6565
[**New issue**](https://github.com/modelcontextprotocol/inspector/issues/new/choose)
6666
offers a **Bug report** and a **Feature request** form. Blank issues are
6767
disabled, so pick one of the two — the required fields (which client, which
68-
version line, which transport) are exactly the facts triage needs first. The
68+
version line, which transport) are exactly the facts triage needs first.
69+
(GitHub serves the chooser from the repository's **default branch**, so what
70+
you see when filing is whatever has reached `main`; a form added on `v2/main`
71+
appears at the next milestone merge.) The
6972
same chooser links out to the private security-advisory process, to this
7073
policy, and to the specification and SDK repositories for reports that aren't
7174
about the Inspector itself.

0 commit comments

Comments
 (0)