Skip to content

Document the commit-subject convention for version.gradle.kts - #41

Open
alexander-yevsyukov wants to merge 1 commit into
masterfrom
document-version-commit-subject
Open

Document the commit-subject convention for version.gradle.kts#41
alexander-yevsyukov wants to merge 1 commit into
masterfrom
document-version-commit-subject

Conversation

@alexander-yevsyukov

Copy link
Copy Markdown
Contributor

What

Documents the team convention that every commit touching the root version.gradle.kts uses the subject Bump version -> `<version>` — even when the edit is syntax-only (e.g., migrating by extra(...) to extra.set(...)) and the version number does not change.

  • guidelines/version-policy.md — new section Commit messages for version.gradle.kts stating the rule, the rationale, and explicit guidance that reviewers (human and agent) must not flag repeated bump subjects on one branch, or a subject "claiming" an already-happened bump, as findings for this file.
  • skills/bump-version/SKILL.md — reconciles the skill with the convention:
    • One bump per branch now constrains commits that advance the version, noting the subject itself is legitimately reused by syntax-only edits.
    • Step 4 states the subject applies to every commit touching the file, with the rationale.
    • Step 7's validation no longer reports >1 bump subjects as over-bumped outright; it now checks how many of the counted commits actually advance the version value, expecting exactly one.

Why

GitHub's repository tree view shows, next to each file, the subject of the last commit that touched it. Keeping the bump-style subject "afloat" beside version.gradle.kts lets anyone read the current version of master straight from the file listing, without opening the file. Product-owner decision (2026-08-05), after a review flagged a syntax-only migration commit as a "duplicate bump".

Reviewer notes

  • spine-code-review/SKILL.md needs no change: it enumerates no commit-message checks (its version gate compares version values, not subjects). The only subject-count check in the skill set lived in bump-version step 7 and is fixed here.
  • Consumer repos pick this up when ./config/pull next floats .agents/shared.
  • Pre-PR ran with review-docs: APPROVE WITH CHANGES — no Must-fix; four Should-fix prose points (colon before the fence, a widow, a runt, one restrictive "which") noted in the session for follow-up.

🤖 Generated with Claude Code

Every commit touching the root `version.gradle.kts` uses the subject
"Bump version -> `<version>`" — even a syntax-only edit, such as the
`by extra(...)` -> `extra.set(...)` migration, which repeats the
unchanged current version. GitHub's tree view shows the last-touching
commit's subject next to each file, so the convention keeps the current
version of `master` readable straight from the file listing.

`guidelines/version-policy.md` gains a section stating the rule, the
rationale, and what reviewers must not flag for this file.
`skills/bump-version/SKILL.md` is reconciled with the convention:
"one bump per branch" and the step-7 validation now count commits that
advance the version value, not commits merely reusing the subject.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Copilot AI lite review requested due to automatic review settings August 5, 2026 23:30

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Documents a team convention for commit subjects when editing the root version.gradle.kts, so GitHub’s tree view reliably shows the current version next to the file. Updates the bump-version skill documentation to align its “one bump per branch” guidance and validation steps with this convention.

Changes:

  • Add a new “Commit messages for version.gradle.kts” section to the version policy, including rationale and reviewer guidance.
  • Clarify in bump-version that “one bump per branch” refers to version advancement, not uniqueness of the Bump version -> subject.
  • Adjust the validation step to treat repeated bump-subject commits as potentially valid and to focus on counting version-advancing commits.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.

File Description
guidelines/version-policy.md Defines the commit-subject convention for version.gradle.kts, plus rationale and reviewer expectations.
skills/bump-version/SKILL.md Aligns the skill’s commit guidance and validation narrative with the new policy.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.


## Commit messages for `version.gradle.kts`

Every commit that touches the root `version.gradle.kts` uses the subject

- repeated `Bump version ->` subjects on one branch, when only one of
those commits actually advances the version;
- a subject that "claims" a bump which already happened earlier on the
Comment on lines 299 to 303
Interpret `count`:

- **1** — expected. The branch carries exactly one bump.
- **0** — the bump commit is missing: this step ran but the Checklist did not
produce a commit. Investigate and report; do not silently proceed.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: db8873ee62

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment on lines +304 to +308
- **>1** — more than one commit uses the bump subject. This alone is *not*
over-bumping: per the [policy][version-policy], a syntax-only edit to
`version.gradle.kts` (e.g. the `by extra(...)` migration on its own) also
uses the `Bump version ->` subject while repeating the current version —
never flag such subject reuse as a finding. Check how many of the counted

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Verify advancement when the subject count is one

When a branch's only matching subject belongs to a syntax-only migration—which the new policy explicitly permits—and no commit actually advances the version, count is 1, so the preceding case declares the validation successful; inspection of the version changes occurs only in this >1 branch. This defeats step 7's missing-bump backstop and lets the skill report success until Version Guard fails. Check for an actual versionToPublish advancement whenever the count is nonzero, not only when it exceeds one.

AGENTS.md reference: AGENTS.md:L3-L7

Useful? React with 👍 / 👎.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants