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

[RFC] Consistent style for commit titles #16

Closed
JamiKettunen opened this issue Nov 14, 2022 · 4 comments
Closed

[RFC] Consistent style for commit titles #16

JamiKettunen opened this issue Nov 14, 2022 · 4 comments

Comments

@JamiKettunen
Copy link

JamiKettunen commented Nov 14, 2022

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:

  • Adding a new package: ${name}: new package (${version})
    • Example: strelaysrv: new package (1.18.6)
  • Updates to existing package: ${name}: update to ${version}
    • Example: strelaysrv: update to 1.22.1
  • Other changes to a package: ${name}: some other changes, enable feature, ...
    • Example: 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 :)

@Eloitor
Copy link

Eloitor commented Nov 14, 2022

The script xbump automatically creates these commit messages for void-packages. Maybe something similar could be done here.

@Elara6331
Copy link
Member

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.

@jansheikkinen
Copy link

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.

@iamwacko
Copy link
Contributor

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.

You could also try squashing PR's and using consistent commit title there.

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

No branches or pull requests

5 participants