git-hygiene-enforcer

Git Hygiene Enforcer

Enforce consistent, high-quality git practices across your team.

Core Workflow

1. Choose conventions: Select commit format (Conventional Commits, Angular, etc.)
2. Setup commit hooks: Install commitlint with git hooks
3. Configure branch rules: Define naming patterns and protection
4. Create PR templates: Standardize pull request descriptions
5. Add workflows: GitHub Actions or GitLab CI for automated checks
6. Document process: Write CONTRIBUTING.md with git guidelines
7. Provide bypasses: Document emergency override procedures

Conventional Commits

Format: <type>(<scope>): <description>

Types:

• feat: New feature
• fix: Bug fix
• docs: Documentation changes
• style: Code style changes (formatting, etc.)
• refactor: Code refactoring
• test: Test additions or changes
• chore: Build/tool changes
• perf: Performance improvements
• ci: CI/CD changes

Examples:

feat(auth): add OAuth2 login
fix(api): resolve race condition in user endpoint
docs(readme): update installation instructions
refactor(utils): simplify date formatting logic

Commit Hook Setup

Using Husky + Commitlint

1. Install dependencies:

npm install --save-dev @commitlint/cli @commitlint/config-conventional husky
npx husky init

1. Configure commitlint (commitlint.config.js):

module.exports = {
  extends: ["@commitlint/config-conventional"],
  rules: {
    "type-enum": [
      2,
      "always",
      [
        "feat",
        "fix",
        "docs",
        "style",
        "refactor",
        "test",
        "chore",
        "perf",
        "ci",
      ],
    ],
    "subject-case": [2, "never", ["upper-case"]],
    "subject-empty": [2, "never"],
    "subject-full-stop": [2, "never", "."],
    "header-max-length": [2, "always", 100],
  },
};

1. Add commit-msg hook (.husky/commit-msg):

#!/bin/sh
npx --no -- commitlint --edit $1

Using pre-commit (Python)