You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/tutorials/writing_commits.md
+11-8Lines changed: 11 additions & 8 deletions
Original file line number
Diff line number
Diff 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.
3
2
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].
6
6
7
7
## Conventional commits
8
8
9
9
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
11
12
add to your commit body the following `BREAKING CHANGE`.
12
13
Using these 3 keywords will allow the proper identification of the semantic version.
13
14
Of course, there are other keywords, but I'll leave it to the reader to explore them.
14
15
15
16
## Writing commits
16
17
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:
18
19
19
20
- Your future self
20
21
- Your colleagues
@@ -27,8 +28,10 @@ understand what happened.
27
28
-**Keep the message short**: Makes the list of commits more readable (~50 chars).
28
29
-**Talk imperative**: Follow this rule: `If applied, this commit will <commit message>`
29
30
-**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.
0 commit comments