Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

RFE: Make CI scripts/git hooks reject commits with "Initial inclusion" in the git summary. #2328

Open
ermo opened this issue Apr 20, 2024 · 1 comment
Assignees
Labels
Topic: Tooling Tools and scripts Type: Feature Something can be enhanced.

Comments

@ermo
Copy link
Contributor

ermo commented Apr 20, 2024

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.

@ermo ermo added Type: Feature Something can be enhanced. Topic: Tooling Tools and scripts labels Apr 20, 2024
@github-project-automation github-project-automation bot moved this to Triage in Solus Apr 20, 2024
@malfisya
Copy link
Member

This solves half of the problem.

@malfisya malfisya moved this from Triage to Needs More Info in Solus Nov 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Topic: Tooling Tools and scripts Type: Feature Something can be enhanced.
Projects
Status: Needs More Info
Status: Todo
Development

No branches or pull requests

3 participants