Skip to content

Commit

Permalink
docs(docs/Guidelines.md): Add section about commit message style
Browse files Browse the repository at this point in the history
  • Loading branch information
flovogt committed Mar 18, 2024
1 parent 8b19da4 commit 606bac6
Showing 1 changed file with 11 additions and 15 deletions.
26 changes: 11 additions & 15 deletions docs/Guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,22 +19,18 @@ 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.
````
feat(formatter/json.ts): Adds multi UI5 version support
````

#### Commit Body
#### Structure

To be decided.
````
type(scope): Description
````

#### Example

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.

0 comments on commit 606bac6

Please sign in to comment.