docs: make minor improvements to release note template
Metadata
Current evaluation
Merged in #328 via commit fbd7c43: clarified that present-tense “now” is acceptable in release notes, added examples, and made fixed-issue entries explicitly links.
Resolution: closed resolved
Reason: The documentation PR was merged after approval from three reviewers. Commit fbd7c43 records the release-note template improvements.
Evaluated by: mr-cal-bot
No scores available.
Issue body
- For notes, add text describing how present tense with "now" is permissible, and add examples that demonstrate it.
- Make it clearer that the items in the fixed issue list should be links.
- [x] Have you followed the guidelines for contributing?
- [x] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)?
- [x] Have you successfully run `tox`?
---
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Merged in #328 via commit fbd7c43: clarified that present-tense “now” is acceptable in release notes, added examples, and made fixed-issue entries explicitly links. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged PR #328 improved the release-note template by clarifying present-tense “now,” adding examples, and requiring links for fixed issues in commit fbd7c43. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged release-note template updates clarifying that present-tense “now” is permissible, with examples and linked fixed-issue entries. | |
| qwen/qwen3.6-35b-a3b | — | — | Merged minor release note template updates. Changes clarify present tense usage with "now" and require hyperlinked fixed issues. Approved by three reviewers with passing CI checks. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged minor updates to the release note template. Added examples and guidance for present tense usage with now, and clarified that fixed issue list items must be hyperlinks. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #1112 docs(changelog): add template and refs to all releases | craft-parts | merged | Merged #1112 (commits 1bbdaf6c, 61ff44af): added stable release-note reference tags and a reusable changelog template so generated links no longer shift. | |
| #286 docs: add release notes index and template | starbase | merged | Merged into main as commit dfe2e9a ("docs: add release notes index and template (#286)"), adding docs/release-notes/index.rst with a release notes TOC section and inline release-note template. | |
| #375 docs: add patch fixes to release notes template | starbase | merged | Merged canonical/starbase#375 in commit f5bcb08, adding patch-fix sections to the release notes template with separate headings for each applicable release. | |
| #5386 docs: link from changelog to release notes | snapcraft | merged | Merged PR #5386 (commit 3fa3a6a3a) added a notice that the changelog was superseded by, and links to, the release notes. |