-
Notifications
You must be signed in to change notification settings - Fork 10
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
[RFC] Consistent style for commit titles #16
Comments
The script xbump automatically creates these commit messages for void-packages. Maybe something similar could be done here. |
The issue is that there's no way to enforce the usage of these commit messages, there will be some contributors just not using them because they either forgot or didn't read the documentation. |
What if the commit format is just a strong recommendation, instead of a requirement? If the goal is nice-to-read commit history, I personally feel like that goal can be easily achieved so long as most commits follow the format. |
You could also try squashing PR's and using consistent commit title there. |
I do rather like how the commits to
void-packages
are done, would it be too much of a hassle for contributors to start using something consistent? I propose these commit titles:${name}: new package (${version})
strelaysrv: new package (1.18.6)
${name}: update to ${version}
strelaysrv: update to 1.22.1
${name}: some other changes, enable feature, ...
strelaysrv: fix cheksums
The important thing is the
${name}:
prefix on each commit title, even on updates you could suffix it with, something else
if it's important enough to state in the commit title. The extended commit message itself would still be free-form.Having the titles standardized would make the commit history nice to read and you can tell at a glance what is going on in each as well :)
The text was updated successfully, but these errors were encountered: