← Back to issue list

docs(HACKING): update commit message guidelines

View original Github issue

Metadata

Project
starbase
Number
#162
Type
pull request
State
merged
Author
mr-cal
Labels
—
Created
Updated
Closed

Current evaluation

Merged PR #162 into main via commit 4b2c78e, making HACKING commit-message guidance more descriptive and authoritative.

Resolution: closed resolved

Reason: The documentation update was merged as commit 4b2c78e, titled "docs(HACKING): update commit message guidelines," changing three files with 165 additions and 12 deletions.

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`? ----- Updates to commit message guidelines to be more descriptive and authoritative. Preview RST [here](https://github.com/canonical/starbase/blob/conventional-commit-documentation/HACKING.rst)

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed resolved Merged PR #162 into main via commit 4b2c78e, making HACKING commit-message guidance more descriptive and authoritative.
stealth/space-bunny-alpha — closed resolved Merged into main via #162 (4b2c78e), making HACKING.rst's Conventional Commits guidance clearer and more authoritative.
qwen/qwen3.6-35b-a3b — — Merged updates to commit message guidelines in HACKING.rst for greater clarity. Approved by three reviewers, passed CI with 100% coverage, and modified three files. Minor commit type discussion did not block integration.
qwen3.6-35b-a3b-mtp-q6 — — Merged documentation update to the HACKING guide, refining commit message guidelines for clarity and authority. Test coverage remained at 100%. Maintainers discussed introducing a dedicated merge commit type or using chore for documentation-only changes.

Update history

No update history recorded yet.

Related issues

Issue Project State Summary Similarity
#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).
83%
#346 docs(HACKING): add note about revert commits starbase merged Merged PR #346 added guidance to describe revert commits using conventional-commit syntax.
79%
#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.
78%
#215 docs: add CONTRIBUTING.md imagecraft merged Merged PR #215 in commit b0aa9f2, replacing HACKING.md with a 312-line CONTRIBUTING.md aligned to the project's contribution model.
76%
#910 Update HACKING.md snapcraft merged Docs-only PR merged as commit bccc3e4f9 ("Update HACKING.md (#910)", Nov 2016): dropped an obsolete testing section and relocated the testing instructions after the dependency-install steps in HACKING.md.
76%
#349 style(HACKING): fix typo starbase merged Merged PR #349 fixed a one-line spelling typo in HACKING; commit daba40f records the change.
76%
#225 docs(HACKING): add details on changelog convention starbase merged Merged #225, adding 27 lines to HACKING.md to document Starbase's changelog convention, adapted from canonical/craft-application#377.
74%
#2568 docs: consolidate on a simple HACKING.md snapcraft merged Merged PR #2568 via commit d66877fc79, consolidating contributor setup and development guidance into one simple, consistent HACKING.md.
74%
#791 docs: update CONTRIBUTING.md craft-application merged Docs-only PR #791 merged as commit 60bc3fae, rewriting CONTRIBUTING.md (+278/-319, 3 files) and deleting HACKING.md. Approved by 2 reviewers; only the OSV-scanner check failed.
73%
#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.
73%