Skip to content

Commit 7707dd1

Browse files
committed
Point contributors at .nextchanges in PR template and pr-checklist
Update the contributor-facing guidance to add a .nextchanges/<section>/<name>.md fragment instead of editing NEXT_CHANGELOG.md: each PR adds its own file so entries never conflict, the filename is arbitrary, the leading bullet and the PR link are optional, and it can be created from the GitHub UI. These are the only two docs that described the old workflow. Co-authored-by: Isaac
1 parent 368042d commit 7707dd1

2 files changed

Lines changed: 7 additions & 6 deletions

File tree

.agent/skills/pr-checklist/SKILL.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ If an agent (you) authored or substantially helped author the PR, disclose it on
5555

5656
## Changelog entry
5757

58-
Add a `NEXT_CHANGELOG.md` entry when your change is user-visible. CI generates the real `CHANGELOG.md` from `NEXT_CHANGELOG.md` at release time, so never hand-edit `CHANGELOG.md` directly.
58+
Add a changelog fragment under `.nextchanges/` when your change is user-visible. Each PR adds its own file, so entries never conflict between PRs. CI collates the fragments and generates the real `CHANGELOG.md` at release time, so never hand-edit `CHANGELOG.md` or `NEXT_CHANGELOG.md` directly.
5959

6060
**When to add an entry:**
6161
- New or changed CLI command, flag, or subcommand behavior
@@ -69,7 +69,7 @@ Add a `NEXT_CHANGELOG.md` entry when your change is user-visible. CI generates t
6969
- Auto-generated output changes without a corresponding user-facing change
7070

7171
**How to add:**
72-
- Pick the right section (`CLI`, `Bundles`, `Dependency updates`) under the current `## Release vX.Y.Z` header.
73-
- One or two sentences, user-facing language, no Jira links.
74-
- Reference the PR number once it's open: after `gh pr create`, edit the entry to append ` (#NNNN)` or similar matching nearby entries.
75-
- Match the voice and tense of the existing entries in the file.
72+
- Create `.nextchanges/<section>/<name>.md`, picking the section folder that fits: `cli`, `bundles`, `dependency-updates`, `notable-changes`, or `api-changes`. `<name>` is arbitrary (a feature name or your PR number) — just keep it unique. You can create it straight from the GitHub UI.
73+
- Write one or two sentences in user-facing language, no Jira links. The leading `* ` is optional. Match the voice and tense of existing changelog entries.
74+
- A PR link is optional: write `(#NNNN)` in the text and it's expanded to a full link automatically.
75+
- See `.nextchanges/README.md` for details.

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,5 @@ For example, were there any decisions behind the change that are not reflected i
99
<!-- How have you tested the changes? -->
1010

1111
<!-- If your PR needs to be included in the release notes for next release,
12-
add a separate entry in NEXT_CHANGELOG.md as part of your PR. -->
12+
add a changelog fragment: create .nextchanges/<section>/<name>.md with a
13+
one-line description (e.g. .nextchanges/cli/quickstart.md). See .nextchanges/README.md. -->

0 commit comments

Comments
 (0)