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.

Sign up for GitHub

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

docs(docs/Guidelines.md): Add section about commit message style #37

Merged
merged 1 commit into from
Mar 20, 2024
Merged

docs(docs/Guidelines.md): Add section about commit message style #37

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 13 additions & 14 deletions docs/Guidelines.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,22 +19,21 @@ Please use [rebase instead of merge](https://www.atlassian.com/git/tutorials/mer

### Commit Message Style

#### Commit Summary
This project uses the [Conventional Commits specification](https://www.conventionalcommits.org/) to ensure a consistent way of dealing with commit messages.

To be decided.
````
fix(xml-transpiler): Log unknown namespaces as verbose instead of warning

#### Commit Body
Ignoring them seems safe, so no warning should be produced. There's
typically also nothing a developer can do to resolve the warning.
````

To be decided.
#### Structure

#### Example
````
type(scope): Description
````

To be decided.

## Work on Release Branches

To be decided.

### Implementing Changes in Multiple Code Lines

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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

https://www.masterclass.com/articles/sentence-case-explained

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, but I can't find "proper nonce" on that page 😄