Git Workflow, Branch Naming, and Commit Standards: Best Practices and Tooling

When a new project encounters confusing Git history with branches like task/10001 , hotfix/0910 , and commit messages such as 实现10001需求 , the author proposes a formal Git standard to improve readability and traceability.

The recommended workflow uses two long‑living branches: main for production releases (e.g., tags v1.0 , v2.0 ) and develop for continuous integration. Feature development occurs on feature/* branches, which are merged into develop . When a release is ready, a release/x.y.z branch is created from develop ; after testing, it is merged into both main and develop . Hotfixes are created directly from main and merged back to both main and develop .

Branch naming follows clear prefixes:

feat : new features (e.g., feat/1000-list-dynamic-loading )

fix : bug fixes (e.g., fix/2000-list-style-align )

perf : performance improvements (e.g., perf/list-memory-occupation )

refactor : structural changes (e.g., refactor/modules-to-packages )

chore : auxiliary tasks (e.g., chore/eslint-upgrade )

To enforce naming rules, the validate-branch-name tool can be installed globally:

npm i validate-branch-name -g

and added to a .husky pre‑commit hook:

#!/bin/sh
. "$(dirname "$0")/_/husky.sh"
# validate branch name before commit
npx validate-branch-name

The tool’s configuration in package.json looks like:

"validate-branch-name": {
  "pattern": "^(master|main|develop){1}$|^(feat|fix|hotfix|release|perf|refactor|chore)/.+$",
  "errorMsg": "分支命名不规范，请修正!"
}

Additional commit‑message enforcement is achieved with Husky, Commitizen, and Commitlint. Install Husky:

npx husky-init && npm install

Install and configure commitizen with the cz-conventional-changelog adapter:

npm install commitizen --save-dev
commitizen init cz-conventional-changelog --save-dev --save-exact

Install Commitlint and add a commitlint.config.js file:

module.exports = {
  extends: ['@commitlint/config-conventional'],
  parserPreset: {
    parserOpts: {
      issuePrefixes: ['#'],
    },
  },
};

Hook the validation into Git via Husky:

npx husky add .husky/commit-msg 'npx --no -- commitlint --edit $1'

Finally, add a prepare-commit-msg hook to launch the interactive Commitizen prompt:

#!/usr/bin/env sh
. "$(dirname -- "$0")/_/husky.sh"
exec < /dev/tty && npx cz --hook || true

In summary, a solid Git standard covers workflow, branch naming, and commit conventions, supported by tools that automate validation and provide interactive guidance, thereby improving codebase readability, reducing troubleshooting time, and enhancing overall development efficiency.