docs(docs/Guidelines.md): Add section about commit message style #37
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
matz3
reviewed
Mar 19, 2024
flovogt
force-pushed
the
guidelines-commit-message
branch
from
606bac6 to
ffd6d2d
Compare
matz3
approved these changes
Mar 19, 2024
RandomByte
reviewed
Mar 20, 2024
| To be decided. | ||
| - required: every commit message has to start with a lowercase `type`. The project has defined a set of [valid types](../.commitlintrc.js#L6). | ||
| - optional: the `scope` is typically the affected module. If multiple modules are affected by the commit, skip it or define a meaningful abstract scope. | ||
| - required: the `description` has to follow the Sentence Case style. Only the first word and proper nonce are written in uppercase. |
There was a problem hiding this comment.
proper nonce
Was this meant to be written as "proper nouns"? Seems like nonce could be correct too, I'm just not very familiar with the word.
There was a problem hiding this comment.
There was a problem hiding this comment.
Thanks, but I can't find "proper nonce" on that page 😄
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
JIRA: CPOUI5FOUNDATION-784