Shulou(Shulou.com)06/02 Report--

This article introduces the relevant knowledge of "what are the git commit specifications?". In the operation of actual cases, many people will encounter such a dilemma. Next, let the editor lead you to learn how to deal with these situations. I hope you can read it carefully and be able to achieve something!

Why standardize git commit

You've been talking about standardizing commit format, so why do you do it?

Let's first look at a non-standard commit record:

After reading what it feels like and what is written (inner OS), this kind of commit information is undoubtedly a fatal blow to people who want to get effective information from it.

Let's take a look at the commit record of a popular Angular specification in the community:

Is it clear at a glance after reading it?

The canonical commit information in the figure above first provides more historical information for quick browsing. Second, you can filter some commit (such as document changes) to make it easy to find information quickly.

Now that the Angular team specification is the popular commit specification in the community, what exactly is it? Let's take a detailed and in-depth look.

Angular team's commit specification

Its message format is as follows:

(): / / empty line / / empty line

It corresponds to three parts of Commit message: Header,Body and Footer.

Header

The Header section has only one line and includes three fields: type (required), scope (optional), and subject (required).

Type: used to describe the type of commit. Generally speaking, there are the following:

Feat: add feature fix: fix bug docs: only modify the document, such as readme.md style: just change the format, such as commas, indents, spaces, etc. Do not change the code logic. Refactor: code refactoring, no new features or fix bug perf: optimization related, such as improving performance, user experience, etc. Test: test cases, including unit tests, integration tests. Chore: change the build process, or add dependent libraries, tools, etc. Revert: version rollback

Scope: used to describe the scope of influence of commit, such as views, component, utils, test...

Subject: a short description of the purpose of commit

Body

The specific description of the content of this commit modification can be divided into multiple lines. As shown below:

# body: 72-character wrapped. This should answer: # * Why was this change necessary? # * How does it address the problem? # * Are there any side effects? # initial commit

Footer

Some comments, usually links to BREAKING CHANGE (the current code is not compatible with the previous version) or fixed bug (turn off Issue).

After a brief introduction to the above specification, let's talk about commit.template, that is, the git submission information template.

Git submission Information template

If your team has formatting requirements for the submission, you can create a file on the system and configure git to use it as the default template, which makes it easier for the submission to follow the format.

Configure the submission information template with the following command:

Git config commit.template [template file name] / / this command can only set the submission template git config of the current branch-- global commit.template [template file name] / / this command can set the global submission template. Note that there are two bars in front of global.

Create a new .gitmessage.txt (template file) as follows:

# headr: (): #-type: feat, fix, docs, style, refactor, test, chore #-scope: can be empty #-subject: start with verb (such as' change'), 50-character line # # body: 72-character wrapped. This should answer: # * Why was this change necessary? # * How does it address the problem? # * Are there any side effects? # # footer: #-Include a link to the issue. #-BREAKING CHANGE #

After reading the above, will you find it troublesome to configure like me, and it doesn't seem to be easy to configure a near-perfect commit specification for yourself and your team. However, the community also provides us with some assistive tools to help with the submission. Here is a brief introduction to these tools.

Commitizen (cz-cli)

Commitizen is a tool that can interactively create submission information. It helps us to build the submission information step by step from type, as shown in the figure:

First of all, control the arrow keys to point to the type of type you want, and match the feat, fix, docs, perf and so on mentioned above:

You will then be asked to select the documents affected by this submission:

You will be asked to write a short and detailed description of the submission later:

Finally, you will be asked to determine whether this submission is a BREAKING CHANGE or an associated issue that has been enabled:

After looking at the whole process of commitizen above, let's take a look at how to install it.

Install in a global environment:

Commitizen configures commit message according to different adapter. For example, to use Angular's commit message format, you can install cz-conventional-changelog.

# need to install both commitizen and cz-conventional-changelog, the latter is adapter $echo'{"path": "cz-conventional-changelog"}'> ~ / .czrc # installed in adapter $npm install-g commitizen cz-conventional-changelog # configuration using $git cz

Local project installation:

# install commitizen $npm install-- save-dev commitizen # next install the adapter # for npm > = 5.2$ npx commitizen init cz-conventional-changelog-- save-dev-- save-exact # for npm < 5.2$. / node_modules/.bin/commitizen init cz-conventional-changelog-- save-dev-- save-exact / / package.json script field to add the commit command "scripts": {"commit": "git-cz"} / / use $npm run commit

Commitlint

Commitlint is a submission verification tool. The principle is that you can use git hooks to validate information before the actual git commit is submitted to the remote repository. Submitting information that does not comply with the rules will be prevented from being submitted to the remote warehouse.

Let's take a look at the demonstration:

For the Conventional Commits specification, the community has sorted out the @ commitlint/config-conventional package, and we just need to install and enable it.

First install commitlint and the conventional specification:

Npm install-- save-dev @ commitlint/cli @ commitlint/config-conventional

Then configure the commitlint script in package.json:

"commitlint": {"extends": ["@ commitlint/config-conventional"]}

Of course, if you want to configure commitlint separately, you need to create a verification file commitlint.config.js, otherwise the verification will fail.

In order to check the message we entered by executing commitlint at each commit, we also need to use a tool-- husky.

Husky is an enhanced git hook tool. The npm script that we configured in package.json can be executed at all stages of the git hook.

Install husky first:

Npm install-save-dev husky

Then configure the commitmsg script in package.json:

"husky": {"hooks": {"commit-msg": "commitlint-E HUSKY_GIT_PARAMS"}}

At this point, the commitlint configuration is complete.

Gitmoji-cli

We are sure to use memes when chatting with friends, such as. The emergence of memes makes the communication between us and our friends more interesting. If you can use emojis () when git submits commit, it will make each commit more intuitive and more convenient to maintain.

Gitmoji is a plug-in that can achieve this function. Let's take a look at it first.

Do you feel very cool~~?

In fact, the use of gitmoji is very simple:

# install npm I-g gitmoji-cli # use git commit-m': bug: problem fix'

Let's take a look at the official example:

This is the end of the content of "what are the git commit specifications"? thank you for your reading. If you want to know more about the industry, you can follow the website, the editor will output more high-quality practical articles for you!

Welcome to subscribe "Shulou Technology Information " to get latest news, interesting things and hot topics in the IT industry, and controls the hottest and latest Internet news, technology news and IT industry trends.