How to write Conventional Commits easily
Make how-to guides like this one in a snap.
PG

Petr Glaser

Created Apr 01, 2023

How to write Conventional Commits easily

58
    c

Visualstudio

1 Step
1

Open VS Code

You should have opened the whole repository, not just one file.

    p

Github

9 Steps
2

You can see the change in Source Control (Ctrl + Shift + G)

You can see the change in Source Control (Ctrl + Shift + G)
3

Press Ctrl + Shift + P, type ">commitizen" and press Enter

Ctrl + Shift + P opens VS Code navigation menu for commands.

Press Ctrl + Shift + P, type ">commitizen" and press Enter
4

Choose a type of the commit

More information can be found here:
https://www.conventionalcommits.org/

Choose a type of the commit
5

Add the scope of the change (usually ticket number from JIRA) and press ENTER

PS: The text is "Denote the SCOPE of this change (optional)", a tutorial app had some bug.

Add the scope of the change (usually ticket number from JIRA) and press ENTER
6

Write a SHORT, IMPERATIVE tense description of the change and press ENTER

Should be less than 50 characters (it will warn you).

Write a SHORT, IMPERATIVE tense description of the change and press ENTER
7

Optionally provide a LONGER description of the change.Use "|" to break a new line. No spaces around!

I incorrectly added spaces around, you will the result in the end.

Optionally provide a LONGER description of the change. Use "|" to break a new line. No spaces around!
8

If you did some BREAKING CHANGES write them here

It is great for clean history to know if there were some breaking changes (e.g. API).

If you did some BREAKING CHANGES write them here
9

We do not use ISSUES CLOSED, it is a Github feature for automatic linking

We do not use ISSUES CLOSED, it is a Github feature for automatic linking
10

This is the final result of a commit with Commitizen

As you can see, there are spaces at the start of lines "use pipe" and "you see", because I used " | " for separation

This is the final result of a commit with Commitizen
Well done!
Create how-to guides like this in a snap. Get Tango now.