Skip to content

doc: fix commit message template to match the convention - #8

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 this repository actually writes type(scope): subject, which is what CONTRIBUTING.md specifies and what the commit history follows.

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 is exactly what happened on launcher#10.

The file was byte-identical in byeol, launcher, stela and indep, so all four carried the same wrong instructions. This applies the same fix here.

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.

The seven types are unchanged. Only the first line of the file is not a comment, so nothing here leaks into a commit message body.

Depends on

byeolang/byeol#61 updates CONTRIBUTING.md, the source of truth, and should land first. This PR is text-identical to the template in that one.

🤖 Generated with Claude Code

https://claude.ai/code/session_0173PkNPTZf2uLFzoEzUuqVZ

@kniz
kniz merged commit 6355e9a into main Aug 29, 2026
4 checks passed
@kniz
kniz deleted the doc/fix-commit-message-template branch August 29, 2026 08:16
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