-
Notifications
You must be signed in to change notification settings - Fork 120
docs: Introduce conventional commits to CONTRIBUTING.md #1361
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
Conversation
5e48f74 to
a8e860e
Compare
|
CI should be changed too, to verify correct use of conventional commits |
a8e860e to
7c087cb
Compare
Yes. I do not know how to do that. It requires changes in validate-pull-request.yml |
|
Regarding the commit tags, how about we begin them with uppercase? All lower case looks strange to me. |
|
I think the lower case sentencing looks strange. Every other title sentence we begin with upper. Every English sentence in books and articles begin with upper case letter. I have no clue why programmers suddently want to begin sentences with lower case. I will be changing this. The title tags themselves can remain lower case, as we have them elsewhere in texts as well. |
7c087cb to
6611637
Compare
Personally I prefer lowercase just because that way its consistent with other repos that use conventional commits however this repo has enforced uppercase for commit headings so far so uppercase is a reasonable choice too as it maintains consistency with past commits. I do find it odd too though that the convention is lowercase. I think the reasoning was to make it similar to git's messages, same as why imperative mode is preffered. Though imperative mood makes more sense to me because it also has the benefit of using less characters. |
There are a few workflow options in github marketplace that we could consider using |
|
@tintinhamans Can you help with the validate-pull-request.yml ? |
Mauller
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
looks good to me
6611637 to
e9adc2d
Compare
|
Rebased. |
Merge with Rebase
This change suggests to change commit title tags from our current custom ones to the conventional (extended) commit tags as highlighted by @aliendroid1.
The [GEN][ZH] tags are sort of obsolete anyway because we always replicate the changes to Generals in the same commit anyway. Originally it was intended to not lose oversight over which commits need replicating to Generals.
I also renamed
@compileto@buildin code comments so that it is consistent with the conventional commit type name.