docs(HACKING): add details on changelog convention
Metadata
Current evaluation
Merged #225, adding 27 lines to HACKING.md to document Starbase's changelog convention, adapted from canonical/craft-application#377.
Resolution: closed resolved
Reason: PR #225 was approved by two reviewers and merged. Its one-file, 27-line change added the requested changelog convention guidance from canonical/craft-application#377.
Evaluated by: mr-cal-bot
No scores available.
Issue body
- [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`?
-----
Refining changelog convention now that they are getting used in more projects.
source: https://github.com/canonical/craft-application/pull/377
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Merged #225, adding 27 lines to HACKING.md to document Starbase's changelog convention, adapted from canonical/craft-application#377. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged PR #225 added changelog conventions to HACKING, bringing the documentation from craft-application#377 to Starbase. | |
| qwen/qwen3.6-35b-a3b | — | — | Merged documentation update adding changelog convention details to the HACKING guide. Approved by two reviewers, passed CI checks, and subsequently upstreamed to the canonical/starbase repository. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged documentation update detailing changelog conventions for the HACKING guide. Changes were subsequently upstreamed to canonical/starbase to standardize practices across projects. |
Update history
No update history recorded yet.
Related work
-
Related To:
canonical/craft-application#377
(confidence 99%)
This upstream PR was the source for the changelog convention documentation ported to Starbase.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #218 docs(HACKING): document branch names and changelog | starbase | merged | PR #218 was approved and merged, adding 92 lines to HACKING documentation covering branch naming conventions and changelog details. | |
| #162 docs(HACKING): update commit message guidelines | starbase | merged | Merged PR #162 into main via commit 4b2c78e, making HACKING commit-message guidance more descriptive and authoritative. | |
| #607 docs(changelog): update to starbase conventions | craft-providers | merged | Merged PR #607 (commits e2bf0b9, e870c6f, 604233d) refactoring the changelog to starbase conventions: ordered by date, human-readable dates, moved to docs/reference/changelog.rst. Closes #604. | |
| #156 docs: update main project docs | craft-cli | merged | Docs PR merged as commit 74150b7 by maintainer tigarmo: restored Starbase's HACKING.rst and updated README to point at it, ahead of the 2.0.0 release. HACKING.rst later gave way to CONTRIBUTING.md. | |
| #184 docs(HACKING): clarify commit header for merges | starbase | merged | Docs-only PR by maintainer mr-cal merged into main as commit 234b360, clarifying HACKING.rst guidance on the conventional-commit header used for merge commits (+4/-1 in HACKING.rst). | |
| #226 docs: update hacking with explanation for exclamation point | starbase | merged | Merged in canonical/starbase#226 via commit a90bcf7, adding guidance on when commit-message headers should use an exclamation point. |