← 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 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.

Suggested action: —

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
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 Merged a documentation update to the HACKING file to clarify commit header guidelines for merges. The change was approved by a reviewer and successfully integrated.
87%
#346 docs(HACKING): add note about revert commits starbase merged Merged documentation update to the HACKING guide. Added guidance on formatting revert commits using conventional commit standards. Approved by one reviewer, passed CI checks, and merged with a single line addition.
85%
#226 docs: update hacking with explanation for exclamation point starbase merged Merged documentation update to the hacking guidelines. Added an explanation for using exclamation points in commit message headers. Approved by two reviewers with a +13/-3 line change across one file.
81%
#791 docs: update CONTRIBUTING.md craft-application merged Merged after reviewer approval and passing CI checks. Updated CONTRIBUTING.md and removed HACKING.md.
79%
#218 docs(HACKING): document branch names and changelog starbase merged Merged documentation updates to the HACKING file covering branch naming conventions and changelog procedures. Approved by two reviewers, the change adds 92 lines to a single file.
79%
#225 docs(HACKING): add details on changelog convention starbase merged 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.
78%
#5578 docs: update CONTRIBUTING.md snapcraft merged Merged after approvals and passing CI. Updated CONTRIBUTING.md, removed HACKING.md, and reverted a redundant conf.py change. A reviewer noted a remaining README reference to HACKING.md requiring separate handling.
78%
#2568 docs: consolidate on a simple HACKING.md snapcraft merged Merged into master. Consolidates development setup and contribution guidelines into a single HACKING.md file for consistency and easier onboarding. Approved by a reviewer, passed CI checks, and integrated without impacting code coverage.
77%
#4006 docs: update HACKING.md to recurse submodules snapcraft merged Merged documentation update to HACKING.md instructing developers to recurse into submodules for spread tests. Approved by one reviewer and merged by maintainer @mr-cal, who dismissed unrelated test failures.
76%
#349 style(HACKING): fix typo starbase merged Merged a one-line typo fix in the HACKING file. Approved by one reviewer with passing CI checks. The change corrects a spelling error in the contributing guidelines.
75%