git-standards

Enforce Conventional Commits and pre-commit hooks for formatting, linting, and tests.

836|66|Updated Feb 3, 2025
One-click install
npx skills add https://github.com/kreuzberg-dev/html-to-markdown --skill git-standards-kreuzberg-dev
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: git-standards
Source: https://github.com/kreuzberg-dev/html-to-markdown/tree/main/.codex/skills/git-standards
Command: npx skills add https://github.com/kreuzberg-dev/html-to-markdown --skill git-standards-kreuzberg-dev

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill ensures that all Git commits adhere to established standards, improving code history clarity and maintainability.

Core Features & Use Cases

  • Conventional Commits: Enforces a structured commit message format (e.g., feat/fix/docs(scope): description).
  • Pre-commit Hooks: Integrates with pre-commit hooks to automatically check formatting, linting, and tests before a commit is finalized.
  • Scope Enforcement: Defines and enforces allowed scopes for commits (e.g., rust-core, py-binding).
  • Use Case: Maintain a clean and understandable Git history across a large project by ensuring all developers follow the same commit message conventions and quality checks.

Quick Start

Use the git-standards skill to learn about the required commit message format.

Frequently Asked Questions about git-standards

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I enforce conventional commits format in my Git workflow?▼

To enforce conventional commits in your Git workflow, you define a structured commit message format like `feat/fix(scope): description` and validate messages against it. This ensures a structured and auditable commit history across the development team.

Can I use pre-commit hooks to automatically run linting and tests before a commit?▼

Yes, you can use pre-commit hooks to automatically run linting, formatting, and tests before a commit is finalized. This integration ensures code quality checks pass before changes are recorded in the Git history.

What is the best way to maintain a clean Git history across a large project?▼

The best way to maintain a clean Git history across a large project is by ensuring all developers follow the same commit message conventions and pass automated pre-commit quality checks. This improves code history clarity and maintainability.

How do I define and enforce allowed scopes for Git commit messages?▼

To define and enforce allowed scopes for Git commit messages, you configure the commit standard to only accept specific scope parameters, such as `rust-core` or `py-binding`. This enforces a structured message format and categorizes changes effectively.

Does this Git commit standard require any specific testing frameworks to function?▼

No, this Git commit standard does not require specific testing frameworks to function. It integrates with your existing pre-commit hooks to automatically check formatting, linting, and tests before finalizing a commit.