Skip to content

Commit d69a143

Browse files
authored
📝 Update conventional commits example
Add some contents to the example of conventional commits
1 parent de8325d commit d69a143

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

git/commit-message-naming.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,13 +30,13 @@ Access right management is used to check proper authorization to access an API b
3030

3131
## Conventional Commits
3232

33-
Commit messages **MAY** use [Conventional Commits](https://www.conventionalcommits.org/en/) format. It provides guidelines to create a better commit history log, making easier to have automated tasks around it (eg: automated changelogs). Commits would follow the format `<type>[optional scope]: <description>`, where `<type>` might be `feat`/`fix`/`chore`/`docs` etc and breaking changes are indicated on the beginning of the optional body or footer section.
33+
Commit messages **MAY** use [Conventional Commits](https://www.conventionalcommits.org/en/) format. It provides guidelines to create a better commit history log, making easier to have automated tasks around it (e.g. automated changelogs). Commits would follow the format `<type>[optional scope]: <description>`, where `<type>` might be `feat`/`fix`/`chore`/`docs` etc. and breaking changes are indicated on the beginning of the optional body or footer section.
3434

3535
Example:
3636
```
37-
feat(scope-etc): Short and descriptive commit message
37+
git commit -m "feat(survey): add nps survey to the home page
3838
39-
BREAKING CHANGE: Details around the Breaking Change
39+
BREAKING CHANGE: `survey` objects in xml file have been re-used in the global configurations.
4040
```
4141

4242
Please refer to [Conventional Commits docs](https://www.conventionalcommits.org/en/) for more details

0 commit comments

Comments
 (0)