Skip to content

doc: fix commit message template and drop build/ci types - #61

Merged
kniz merged 1 commit into
mainfrom
doc/fix-commit-message-template
Aug 29, 2026
Merged

kniz merged 1 commit into
mainfrom
doc/fix-commit-message-template

Conversation

@kniz

@kniz kniz commented Aug 29, 2026

Copy link
Copy Markdown
Member

Why

.gitmessage.txt documented a commit format this project does not use. It said:

<module>: <type>: <subject>

but every repository actually writes type(scope): subject, which is what CONTRIBUTING.md specifies and what 456 commits across the six repositories follow.

This was not harmless. A contributor who opens the template and follows it writes a malformed subject line, gets it caught in review, and has to amend and force-push. That happened on launcher#10.

The same file is byte-identical in byeol, launcher, stela and indep, so all four carried the same wrong instructions. Companion PRs update the other three.

Template changes

Was Now
#<module>: <type>: <subject> #<type>(<scope>): <subject>
# Module is one of sub module like 'interp', 'seedling' # Scope is the module or area you touched, like 'core' or 'installer'.
#test: interp: add new test case... #test(interp): add new test case...
— a paragraph on keeping messages short

seedling no longer exists, so the scope examples now name modules that do.

The new paragraph says the subject line alone is usually enough and that long reasoning belongs in the PR description. The template previously said nothing about length, which is how a commit ended up carrying three paragraphs of design rationale that should have been here instead.

Type list: dropping build and ci

CONTRIBUTING.md listed nine types while the template listed seven. Rather than widen the template, this narrows the guide: build and ci are removed and those changes are chore.

The example block also used feat(ci):, which reads as though ci were a type. It is now chore(ci):, so the example itself demonstrates that ci is a scope.

Existing build(...) and ci(...) commits are left alone — 11 of them across the repositories. They are merged history and rewriting them buys nothing.

Verification

Types in the template now match CONTRIBUTING.md exactly. Cross-checked against the last 300 commits in each of the six repositories: the seven types cover all but a handful of typos (docs, ffix, core), and scoped subjects outnumber bare ones 299 to 157.

Only the first line of the template is not a comment, so nothing here leaks into a commit message body.

Merge order

This is the source of truth, so it should land before the three template-only PRs.

🤖 Generated with Claude Code

https://claude.ai/code/session_0173PkNPTZf2uLFzoEzUuqVZ

@kniz
kniz merged commit 870a02e into main Aug 29, 2026
6 checks passed
@kniz
kniz deleted the doc/fix-commit-message-template branch August 29, 2026 08:15
@codecov

codecov Bot commented Aug 29, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

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.

1 participant