From 3657c4ea9e689f687e0ec906c84e48620fee8d15 Mon Sep 17 00:00:00 2001 From: Tom Boucher Date: Fri, 1 May 2026 20:01:04 -0400 Subject: [PATCH] fix(#3006): retarget PR-template CHANGELOG checkboxes at the changeset workflow (#3007) The three PR templates still asked contributors to tick `CHANGELOG.md updated`, contradicting the post-#2978 rule (documented in CONTRIBUTING.md and enforced by scripts/changeset/lint.cjs) that `CHANGELOG.md` must not be edited directly. Each checkbox now references `npm run changeset` with the appropriate `--type` (Fixed/Changed/Added) and notes the `no-changelog` opt-out label where applicable, so `gh pr create` users land in the correct workflow by copy-paste. Closes #3006 Co-authored-by: Claude Opus 4.7 --- .changeset/merry-lynx-wander.md | 5 +++++ .github/PULL_REQUEST_TEMPLATE/enhancement.md | 2 +- .github/PULL_REQUEST_TEMPLATE/feature.md | 2 +- .github/PULL_REQUEST_TEMPLATE/fix.md | 2 +- 4 files changed, 8 insertions(+), 3 deletions(-) create mode 100644 .changeset/merry-lynx-wander.md diff --git a/.changeset/merry-lynx-wander.md b/.changeset/merry-lynx-wander.md new file mode 100644 index 000000000..7906957dc --- /dev/null +++ b/.changeset/merry-lynx-wander.md @@ -0,0 +1,5 @@ +--- +type: Fixed +pr: 3007 +--- +**PR templates now point at the changeset workflow** — the `Fix`, `Enhancement`, and `Feature` PR templates previously asked contributors to tick `CHANGELOG.md updated`, which contradicted the post-#2978 rule that `CHANGELOG.md` must not be edited directly. Each checkbox now references `npm run changeset` (and the `no-changelog` opt-out where applicable). diff --git a/.github/PULL_REQUEST_TEMPLATE/enhancement.md b/.github/PULL_REQUEST_TEMPLATE/enhancement.md index 7825fde68..d79e11205 100644 --- a/.github/PULL_REQUEST_TEMPLATE/enhancement.md +++ b/.github/PULL_REQUEST_TEMPLATE/enhancement.md @@ -73,7 +73,7 @@ Closes # - [ ] Changes are scoped to the approved enhancement — nothing extra included - [ ] All existing tests pass (`npm test`) - [ ] New or updated tests cover the enhanced behavior -- [ ] CHANGELOG.md updated +- [ ] `.changeset/` fragment added (`npm run changeset -- --type Changed --pr --body "..."`) — or `no-changelog` label applied if not user-facing - [ ] Documentation updated if behavior or output changed - [ ] No unnecessary dependencies added diff --git a/.github/PULL_REQUEST_TEMPLATE/feature.md b/.github/PULL_REQUEST_TEMPLATE/feature.md index 86765c5b9..47d232a60 100644 --- a/.github/PULL_REQUEST_TEMPLATE/feature.md +++ b/.github/PULL_REQUEST_TEMPLATE/feature.md @@ -94,7 +94,7 @@ Closes # - [ ] Implementation scope matches the approved spec exactly - [ ] All existing tests pass (`npm test`) - [ ] New tests cover the happy path, error cases, and edge cases -- [ ] CHANGELOG.md updated with a user-facing description of the feature +- [ ] `.changeset/` fragment added with a user-facing description of the feature (`npm run changeset -- --type Added --pr --body "..."`) - [ ] Documentation updated — commands, workflows, references, README if applicable - [ ] No unnecessary external dependencies added - [ ] Works on Windows (backslash paths handled) diff --git a/.github/PULL_REQUEST_TEMPLATE/fix.md b/.github/PULL_REQUEST_TEMPLATE/fix.md index 439ae3299..0ef10ede9 100644 --- a/.github/PULL_REQUEST_TEMPLATE/fix.md +++ b/.github/PULL_REQUEST_TEMPLATE/fix.md @@ -63,7 +63,7 @@ Fixes # - [ ] Fix is scoped to the reported bug — no unrelated changes included - [ ] Regression test added (or explained why not) - [ ] All existing tests pass (`npm test`) -- [ ] CHANGELOG.md updated if this is a user-facing fix +- [ ] `.changeset/` fragment added if this is a user-facing fix (`npm run changeset -- --type Fixed --pr --body "..."`) — or `no-changelog` label applied - [ ] No unnecessary dependencies added ## Breaking changes