git commit -m 'your message'

# vim 可以换成你习惯的编辑器
git config --global core.editor "vim"

# 或者设置 GIT_EDITOR 变量，在你的 .bashrc / .zshrc 文件中添加即可
export GIT_EDITOR=vim

Summarize changes in around 50 characters or less

More detailed explanatory text, if necessary. Wrap it to about 72
characters or so. In some contexts, the first line is treated as the
subject of the commit and the rest of the text as the body. The
blank line separating the summary from the body is critical (unless
you omit the body entirely); various tools like `log`, `shortlog`
and `rebase` can get confused if you run the two together.

Explain the problem that this commit is solving. Focus on why you
are making this change as opposed to how (the code explains that).
Are there side effects or other unintuitive consequences of this
change? Here's the place to explain them.

Further paragraphs come after blank lines.

 - Bullet points are okay, too

 - Typically a hyphen or asterisk is used for the bullet, preceded
   by a single space, with blank lines in between, but conventions
   vary here

If you use an issue tracker, put references to them at the bottom,
like this:

Resolves: #123
See also: #456, #789

Subject line (try to keep under 50 characters)

Multi-line description of commit,
feel free to be detailed.

[Ticket: X]

git config commit.template .gittemplate.txt

Subject line (try to keep under 50 characters)

Multi-line description of commit,
feel free to be detailed.

[Ticket: X]
# Please enter the commit message for your changes. Lines starting
# with '#' will be ignored, and an empty message aborts the commit.
# On branch master
# Changes to be committed:
#   (use "git reset HEAD <file>..." to unstage)
#
# modified:   lib/test.rb
#
~
~
".git/COMMIT_EDITMSG" 14L, 297C

• 进入 githooks 所在的目录

  cd /project-repo/.git/hooks
  

  你会看到有这些文件：

  -rwxr-xr-x 1 spike spike  478 Oct 27 19:10 applypatch-msg.sample
  -rwxr-xr-x 1 spike spike  896 Oct 27 19:10 commit-msg.sample
  -rwxr-xr-x 1 spike spike 3079 Oct 27 19:10 fsmonitor-watchman.sample
  -rwxr-xr-x 1 spike spike  189 Oct 27 19:10 post-update.sample
  -rwxr-xr-x 1 spike spike  424 Oct 27 19:10 pre-applypatch.sample
  -rwxr-xr-x 1 spike spike 1638 Oct 27 19:10 pre-commit.sample
  -rwxr-xr-x 1 spike spike  416 Oct 27 19:10 pre-merge-commit.sample
  -rwxr-xr-x 1 spike spike 1348 Oct 27 19:10 pre-push.sample
  -rwxr-xr-x 1 spike spike 4898 Oct 27 19:10 pre-rebase.sample
  -rwxr-xr-x 1 spike spike  544 Oct 27 19:10 pre-receive.sample
  -rwxr-xr-x 1 spike spike 1492 Oct 27 19:10 prepare-commit-msg.sample
  -rwxr-xr-x 1 spike spike 3610 Oct 27 19:10 update.sample
  

• 根据需要的钩子，将 .simple 后缀移除，例如 pre-commit.sample 改为 pre-commit
• 打开文件，设置为你想写的语言

如果你想用 shell:

或者用 python:

• 设置好语言后，就编写脚本，例如 pre-push:

  #!/bin/sh
  COMMIT_ID=$(git log -n 1 --pretty=format:"%H" main)
  
  if git merge-base --is-ancestor $COMMIT_ID HEAD
  then
      exit 0
  else
      echo "主分支有你没有合并的提交，在提测前请合并"
      exit 0
  fi
  

• 保存好脚本后, 当 push 的时候，就会执行 pre-push 里面的脚本，去比对分支，如果不同步则会出现提示文字

但是 githooks 是 存储在本地，不进入版本管理 的。

一个解决办法是在项目中创建一个目录存放 hooks, 同步到远端后，大家拉取下来拷贝 .git/hooks 目录里。

husky 是一个方便写 githooks 的工具，目前也蛮流行的。

它会在项目的根目录下创 .husky 目录，存放 husky 生成的所有 hooks，这样可以避免 hooks 在本地仓库没有同步的问题。

它还会修改 githooks 对应的路径，改写为 .husky 目录, 如果你打开 /project-root/.git/config , 你会看到：

[core]
        hooksPath = .husky

husky 的使用就不赘述了，如果项目可以 husky，建议还是用 husky 来维护 githooks。

安装 commitlint 以来，然后创建 commit-msg 钩子，在提交后，校验提交信息是否符合规范：

#!/usr/bin/env sh
. "$(dirname -- "$0")/_/husky.sh"

npx --no -- commitlint --edit ${1}

#!/usr/bin/env sh
. "$(dirname -- "$0")/_/husky.sh"
npx lint-staged

这里用到了 okonet/lint-staged, 它的作用是对 staged 中的内容(git add 进去的内容)进行一些处理。

.lintstagedrc.json:

{
  "src/*.{js,vue}": ["prettier --write", "eslint"]
}

例如这里就是对 src 下的 js 和 vue 类型的文件，用 pretteir 格式化后，再用 eslint 去校验。

#!/bin/sh
# 获取 main 分支最新的提交
git fetch
COMMIT_ID=$(git log -n 1 --pretty=format:"%H" origin/main)

# 判断 main 的最新提交 是不是 当前的最新提交 (HEAD) 的上游
if git merge-base --is-ancestor $COMMIT_ID HEAD
then
    exit 0
else
    # 如果不是则提示 exit code 不为 0，会阻断 push，无法推送到远程
    echo "主分支有你没有合并的提交，在提测前请合并"
    exit 1
fi

当存在多条分支时，有时容易忘记合并主分支代码，导致测试时丢失主分支的提交。

你就可以写一个 pre-push 钩子，再 push 的时候去校验一下。