Skip to content

Commit 292dd1d

Browse files
committed
docs: added more examples for commit types
1 parent 8740ea7 commit 292dd1d

File tree

1 file changed

+24
-8
lines changed

1 file changed

+24
-8
lines changed

README.md

Lines changed: 24 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -45,30 +45,46 @@ Contributions are highly welcome! This project uses `semantic-release` to automa
4545
When you create a pull request, please make sure your commit messages are structured as follows:
4646
4747
```
48-
<type>[optional scope]: <description>
48+
<type>([optional scope]): <description>
4949
5050
[optional body]
51-
52-
[optional footer(s)]
5351
```
5452
5553
**Common commit types:**
5654
57-
- **feat**: A new feature. (Triggers a `minor` version release)
5855
- **fix**: A bug fix. (Triggers a `patch` version release)
56+
- **feat**: A new feature. (Triggers a `minor` version release)
5957
- **docs**: Documentation only changes. (No release)
60-
- **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc). (No release)
6158
- **refactor**: A code change that neither fixes a bug nor adds a feature. (No release)
62-
- **perf**: A code change that improves performance. (No release)
6359
- **test**: Adding missing tests or correcting existing tests. (No release)
6460
- **chore**: Changes to the build process or auxiliary tools and libraries such as documentation generation. (No release)
6561
6662
To indicate a **breaking change** (which triggers a `major` version release), add a `!` after the type (e.g., `feat!:`) or include `BREAKING CHANGE:` in the commit message footer.
6763
68-
**Example:**
64+
**Examples:**
65+
66+
No release
67+
68+
```
69+
chore: change build process
70+
```
71+
72+
`patch` release
73+
74+
```
75+
fix: added icon
76+
```
77+
78+
`minor` release
79+
80+
```
81+
feat(server): Add option to configure liveness probe
82+
```
83+
84+
`major` release
6985
7086
```
71-
feat: Add option to configure runner liveness probe
87+
feat!: breaking change for pool creation logic
7288
```
7389
7490
Following this convention is crucial as it directly controls the versioning and release notes for the chart.

0 commit comments

Comments
 (0)