RFE: Make CI scripts/git hooks reject commits with "Initial inclusion" in the git summary.
@silkeh is already working on this.
Since Apr 20, 2024.
- Dominant language
- Python
- Stars
- 141
- Forks
- 146
- Avg merge
- 11h 7m
- Merged PRs (30d)
- 407
Description
Any chance we could guide people to use "Add at" instead of "Initial inclusion at" via the git hooks / CI scripts?
I could be persuaded to allow "Include at" at a stretch if "Include" is really that important to people.
But "Initial inclusion" just hertz my soul due to its frequency of appearance... >_>
cf. https://help.getsol.us/docs/packaging/creating-a-new-package#commit-message-format-for-new-packages
Context
Good git commit message practice is to write the message such that it fits into this template: "If I apply this commit, it will (...)"
Example:
"If I add this commit, it will 'pkg: Add at v(something)'" (the prefix is to make it easier to see which recipe a change belongs to at a glance in a monorepo context).
vs.
"If I add this commit, it will 'pkg: Initial inclusion at v(something)'" (now it's even less correct than before)
Additionally, the git commit summary as displayed by the worklog.py script has (I believe) 52 characters before git begins truncating the commit summary. "Add at" is six characters (leaving 46 characters for the package name and the description) whereas "Initial inclusion at" is twenty characters, leaving 32 characters before git begins truncating the commit summary.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.