dev: create convention commit syntax#19089
Conversation
75ae480 to
1150bfb
Compare
3cbe4a6 to
918b140
Compare
|
@gianm updated. I think we should also make the default repo settings on PRs to do a merge and take the PR description (e.g. not just force a *-list of commit messages (which often aren't descriptive at all). |
918b140 to
bab78f4
Compare
|
@gianm thoughts here? |
|
@gianm any thoughts here? |
gianm
left a comment
There was a problem hiding this comment.
I like the idea. Hard to see it causing problems, it's relatively unobtrusive.
By "do a merge" you mean "squash and merge"? I think that's already the default and IMO is best. I'm not sure how I feel about the default description. The problem with concatenating the commits is it can include a bunch of junk. The problem with using the PR description is they tend to be long, IMO too long to be good commit messages. I generally try to edit the commit message when I'm merging a PR. I think there's no way around manual edits being a good idea. Anyway, I'm sort of ambivalent about the default messages, as a result. |
Ah – I wasn't referring to the merge method itself, but rather the default commit message provided by GH when merging (I notice it's a *-bulleted list of commit messages, which aren't that descriptive). I was thinking the commit message could be by default the PR description (and people can trim as needed). Just a minor thing, not too important. |
82d5996 to
57e5253
Compare
57e5253 to
3c08150
Compare
|
Btw, this PR should probably be |
Done. I think that difference is largely immaterial; what does matter is that we are now recording context inside the git tree, which makes it WAY easier to bisect for issues without digging through PR links. It also helps that GH release notes structure can be auto-generated from the conventional commit syntax (meaning you don't need to rely on users specifying Release Notes tag and instead do something like (fix!: blah) to know that it's a breaking change). I could add a general guide on how/what to label things in the workflow – that might be helpful. |
Description
Something I've seen many large open source projects adopt:
Release note
Enforce conventional commit format. This will also help making debugging issues, etc. as in addition to GH tags (something not persisted in the git lineage) breaking changes/bug fixes/feature information is recorded in the git tree.
This PR has: