kayprish/dotfiles
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

📚 docs(COMMIT_MESSAGE): added tools to use

Browse source
This commit is contained in:
Sergio Laín 2023-12-29 23:49:58 +01:00
parent adb0bdef8e
commit 34c143cf68
No known key found for this signature in database
GPG key ID: 14C9B8080681777B
1 changed files with 8 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
.github/COMMIT_MESSAGE_GUIDELINES.md vendored
View file

@ -2,6 +2,8 @@
A good commit message should be descriptive and provide context about the changes made. This makes it easier to understand and review the changes in the future.
The specification used to write human-readable commits is [Conventional Commits](https://conventionalcommits.org).
Here are some guidelines for writing descriptive commit messages:
- Start with a short summary of the changes made in the commit.
@ -149,3 +151,9 @@ These are just some examples, and you can create your own custom commit types as
Emojis are also allowed, always following the commit guidelines mention before.
**Important:** If you are planning to use a custom commit message type other than the ones listed above, make sure to add it to this list so that others can understand it as well. Create a pull request to add it to this file.
## Tools
I recommend using [Commitizen](https://github.com/commitizen/cz-cli) in combination of an adapter such as [cz-git](https://github.com/Zhengqbbb/cz-git) for generating premade, customized and human-readable commit messages.
If you wanna take a look, you have my config file for Commitizen [right here](../.czrc).