← Back to issue list

docs: make minor improvements to release note template

View original Github issue

Metadata

Project
starbase
Number
#328
Type
pull request
State
merged
Author
medubelko
Labels
Created
Updated
Closed

Current evaluation

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.

Suggested action:

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
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
#2248 docs: update to the latest release notes template charmcraft merged Merged documentation update to the latest release notes template. Changes include auto-formatting across seven files, approved by two reviewers, and passed most continuous integration checks.
79%
#286 docs: add release notes index and template starbase merged Merged documentation update adding a release notes index to the TOC and a template. Approved by three reviewers, passed CI, and modified six files. Reviewers confirmed the forward-porting section remains optional.
77%
#1112 docs(changelog): add template and refs to all releases craft-parts merged Merged changelog improvements that replace dynamic reference tags with stable identifiers to prevent broken links. Adds a standardized template for consistent future releases. Approved by two reviewers and passed all CI checks.
76%
#375 docs: add patch fixes to release notes template starbase merged Merged changes adding patch fixes section to release notes template. Approved by three reviewers with passing CI checks. Headings apply only to releases with fixes, using separate entries for subsequent patches while leaving older releases unchanged.
76%
#5386 docs: link from changelog to release notes snapcraft merged Merged a documentation update adding a notice in the changelog linking to the release notes, per @simondeziel's feedback. Approved by two reviewers and passed CI. The changelog is now superseded by the release notes.
74%
#258 docs: update readme and template, fix build error starbase merged Merged after two reviewer approvals and passing CI. Updated README wording, added doc preparation details, and disabled PDF and EPUB generation to resolve build errors. All changes passed tests with 100% coverage.
74%
#6173 docs: format doc version as major.minor snapcraft merged Merged a documentation update that formats version strings as major.minor. Approved by two reviewers, passed CI checks, and integrated with a three-line change.
73%
#588 docs: fix version in title starbase merged Merged documentation update correcting version display in titles. Builds now show major and minor versions, with latest displaying dev. Approved by two reviewers and passed all CI checks.
73%
#520 docs: format doc version as major.minor starbase merged Merged following approval from two reviewers and successful CI checks. The change formats documentation versions as major.minor and removes the redundant html_title assignment, modifying one file with eight additions and two deletions.
73%
#930 docs(changelog): backfill release links and add a template craft-application merged Merged documentation pull request that backfills changelog release links and adds a template. Approved by three reviewers, passed all CI checks, and modified one file with 28 additions and one deletion.
72%