Skip to content

Commit 4c5e561

Browse files
joshtrichardsrakekniven
authored andcommitted
docs: add release notes instructions for maintainers
Adds a brief instructions file to `.github/` documenting the prompt and process for generating consistent release notes using an AI assistant. Intended for use by maintainers when preparing releases. Signed-off-by: Josh <josh.t.richards@gmail.com>
1 parent 747fc68 commit 4c5e561

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Release Notes Instructions
2+
3+
When generating release notes for a new release, use the following prompt with GitHub Copilot (or another AI assistant), substituting the changelog and version number as appropriate.
4+
5+
---
6+
7+
## Prompt
8+
9+
Generate release notes for **[version]** of the `nextcloud/documentation` repository based on the following changelog.
10+
11+
For each PR in the changelog, look up the original (non-backport) PR to identify the true author. Organize the release notes into sections by which manual the PR touches: **Admin Manual**, **Developer Manual**, and **User Manual**. If a PR touches multiple manuals, include it in each relevant section with a summary appropriately tuned to that manual's audience. Eliminate any section for which there are no PRs.
12+
13+
For each entry, write a concise human-readable summary (not just the PR title), and attribute it with `by @author in #number`.
14+
15+
At the end, include a **New Contributors** section calling out any authors whose `author_association` on the original PR is `CONTRIBUTOR` (rather than `MEMBER`) — these are first-time or external contributors.
16+
17+
All PRs are backported via `@backportbot` — include a note at the bottom acknowledging this and clarifying that original authors are credited throughout.
18+
19+
**Changelog:**
20+
21+
[paste changelog here]
22+
23+
---
24+
25+
## Notes
26+
27+
- The changelog can be found on the [releases page](https://github.com/nextcloud/documentation/releases) or generated via GitHub's "Generate release notes" button as a starting point.
28+
- The key instructions that drive the correct output are:
29+
1. **Look up original PRs** to get the real author, not `backportbot`
30+
2. **Organize by manual**, not by type of change
31+
3. **Cross-manual PRs appear in each relevant section** with tuned summaries
32+
4. **`CONTRIBUTOR` association = new/external contributor** worth calling out

0 commit comments

Comments
 (0)