Skip to content

Commit 79b3156

Browse files
bcdadyLee-W
authored andcommitted
Address typos and layout
Resolve some minor typos and line up long line wrap point
1 parent ec38ce3 commit 79b3156

File tree

1 file changed

+11
-8
lines changed

1 file changed

+11
-8
lines changed

docs/tutorials/writing_commits.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,21 @@
1-
For this project to work well in your pipeline, a commit convention
2-
must be followed.
1+
For this project to work well in your pipeline, a commit convention must be followed.
32

4-
By default commitizen uses the known [conventional commits][conventional_commits], but you can create
5-
your own following the docs information over [customization][customization].
3+
By default commitizen uses the known [conventional commits][conventional_commits], but
4+
you can create your own following the docs information over at
5+
[customization][customization].
66

77
## Conventional commits
88

99
If you are using [conventional commits][conventional_commits], the most important
10-
thing to know is that you must begin your commits with at least one of these tags: `fix`, `feat`. And if you introduce a breaking change, then, you must
10+
thing to know is that you must begin your commits with at least one of these tags:
11+
`fix`, `feat`. And if you introduce a breaking change, then, you must
1112
add to your commit body the following `BREAKING CHANGE`.
1213
Using these 3 keywords will allow the proper identification of the semantic version.
1314
Of course, there are other keywords, but I'll leave it to the reader to explore them.
1415

1516
## Writing commits
1617

17-
Not to the important part, when writing commits, it's important to think about:
18+
Now to the important part, when writing commits, it's important to think about:
1819

1920
- Your future self
2021
- Your colleagues
@@ -27,8 +28,10 @@ understand what happened.
2728
- **Keep the message short**: Makes the list of commits more readable (~50 chars).
2829
- **Talk imperative**: Follow this rule: `If applied, this commit will <commit message>`
2930
- **Think about the CHANGELOG**: Your commits will probably end up in the changelog
30-
so try writing for it, but also keep in mind that you can skip sending commits to the CHANGELOG by using different keywords (like `build`).
31-
- **Use a commit per new feature**: if you introduce multiple things related to the same commit, squash them. This is useful for auto-generating CHANGELOG.
31+
so try writing for it, but also keep in mind that you can skip sending commits to the
32+
CHANGELOG by using different keywords (like `build`).
33+
- **Use a commit per new feature**: if you introduce multiple things related to the same
34+
commit, squash them. This is useful for auto-generating CHANGELOG.
3235

3336
| Do's | Don'ts |
3437
| ---- | ------ |

0 commit comments

Comments
 (0)