Skip to content

Commit e2a2511

Browse files
committed
Docs update.
1 parent 11422ec commit e2a2511

File tree

2 files changed

+11
-15
lines changed

2 files changed

+11
-15
lines changed

README.md

Lines changed: 10 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -70,23 +70,19 @@ makeapp change "+ New 'change' command implemented"
7070

7171
This will also stage and commit all changed files.
7272

73-
Supported message prefixes:
73+
Supported message prefixes and corresponding version number parts incremented
74+
on `release` command:
7475

75-
* ``+`` - New feature / addition.
76+
| symbol | meaning | version part increment |
77+
|--------|----------------------------------|------------------------|
78+
| `+` | New feature / addition | minor |
79+
| `!` | Important change/improvement/fix | patch |
80+
| `-` | Feature deprecation / removal | patch |
81+
| `*` | Minor change/improvement/fix | patch |
7682

77-
Increments *minor* part of version number on ``release`` command.
7883

79-
* ``!`` - Important change/improvement/fix.
80-
81-
Increment: *patch* part.
82-
83-
* ``-`` - Feature deprecation / removal
84-
85-
Increment: *patch*.
86-
87-
* ``*`` - Minor change/improvement/fix. ``*`` prefix is added by default if none of the above mentioned prefixes found.
88-
89-
Increment: *patch*.
84+
!!! note
85+
`*` prefix is added by default if none of the above-mentioned prefixes found.
9086

9187

9288
## Bash completion

docs/010_quickstart.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ on `release` command:
8181

8282

8383
!!! note
84-
`*` prefix is added by default if none of the above mentioned prefixes found.
84+
`*` prefix is added by default if none of the above-mentioned prefixes found.
8585

8686

8787
## Bash completion

0 commit comments

Comments
 (0)