Engineering
Git Commit Format avatar

Git Commit Format

Enforce HyperShift conventional commit formatting and validation for all Git contributions.

Introduction

This skill ensures that all Git commits within the HyperShift repository strictly adhere to the project's conventional commit formatting rules. Designed for developers and maintainers working on the OpenShift-based HyperShift control plane, it streamlines the process of generating standardized commit messages, maintaining repository hygiene, and meeting automated CI requirements. By leveraging this tool, you ensure that every commit follows the established syntax, including proper scoping, type classification, and mandatory footers required for project compliance.

  • Automatically enforces conventional commit structure: <type>(<scope>): <description>.

  • Manages required metadata including Signed-off-by footers and source tracking via the Commit-Message-Assisted-by: Claude (via Claude Code) footer.

  • Supports all standard commit types like feat, fix, docs, chore, test, and ci for granular history tracking.

  • Provides automated handling for breaking changes using the ! syntax or BREAKING CHANGE footers.

  • Integrates validation workflows with make run-gitlint to ensure compliance before pushing code.

  • Use this skill whenever you are generating commit messages or committing changes to the HyperShift codebase.

  • Ensure your environment variables GIT_AUTHOR_NAME and GIT_AUTHOR_EMAIL are configured, as the agent retrieves these for the Signed-off-by footer.

  • Be aware of the length constraints: 120 characters maximum for the title line and 140 characters per line for the body.

  • Always include the assist footer when Claude generates or drafts your commit message to provide full transparency in the git log.

  • Run the project-specific gitlint validation to catch potential formatting errors before CI pipelines reject your submission.

Repository Stats

Stars
523
Forks
475
Open Issues
243
Language
Go
Default Branch
main
Sync Status
Idle
Last Synced
May 1, 2026, 09:38 AM
View on GitHub