Index of every page on this site: llms.txt
All skills
openshift avatar

/git-commit-format

@0f43b29 official
by openshiftopenshift/hypershift555 stars
592
Run it yourself

Apply HyperShift conventional commit formatting rules. Use when generating commit messages or creating commits.

Use this Skill: https://skilld.dev/gh/openshift/hypershift/git-commit-format

Nothing lands on disk. Nothing to clean up.

Fork this Skill

Edit a local copy. It keeps the author and licence.

SKILL.md

≈33 tokens for metadata: the name and description. ≈1.2k when used: this file.

Description uses 1.6% of example budget

Before choosing a Skill, your Agent reads its name and description. All available Skills share that space.

  • A shorter description leaves more room for other Skills. This entry exceeds our 1% size suggestion.

In our Claude Code example, all Skill names and descriptions share 8,000 characters. This Skill uses ≈131 characters, or 1.6%.

The 1% threshold is a size suggestion. Longer descriptions can still fit.

Your model, settings, and other Skills decide how much text your Agent can read.

Example settings and source

The example uses a 200k-token context and default Claude Code settings. The count includes the name, description, separators, and when_to_use when present. Codex also counts local file paths.

Skit's source and limits: Codex 0.160.1, Claude Code 2.1.292.

Git Commit Message Formatting Rules

Apply conventional commit format for all git commits in the HyperShift project.

Commit Message Format

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

[optional body]

[footers]

Commit Types

  • feat: New features
  • fix: Bug fixes
  • docs: Documentation changes
  • style: Code style changes (formatting, etc.)
  • refactor: Code refactoring (no functional changes)
  • test: Adding/updating tests
  • chore: Maintenance tasks
  • build: Build system or dependency changes
  • ci: CI/CD changes
  • perf: Performance improvements
  • revert: Revert previous commit

Breaking Changes

With ! to draw attention

feat!: send email when product shipped

With BREAKING CHANGE footer

feat: allow config to extend other configs

BREAKING CHANGE: `extends` key now used for extending config files

Both ! and BREAKING CHANGE

chore!: drop support for Node 6

BREAKING CHANGE: use JavaScript features not available in Node 6.

Required Footers

Signed-off-by Footer

ALWAYS include Signed-off-by footer with name and email.

Get credentials in this priority order:

  1. Environment variables: $GIT_AUTHOR_NAME and $GIT_AUTHOR_EMAIL
  2. Git config: git config user.name and git config user.email
  3. If neither configured, ask the user to provide details

Assisted-by Footer

Include an Assisted-by: LLM footer when an AI assistant helps create or generate the commit message. Do not include it for human-authored commit messages.

Assisted-by: LLM

Gitlint Validation Rules

  • Run make run-gitlint to validate commit messages
  • Title line: 120 characters maximum
  • Body line: 140 characters maximum per line
  • Use conventional commit format
  • Include required footers (Signed-off-by)
  • No trailing whitespace

Examples

Simple commit

docs: correct spelling of CHANGELOG

Signed-off-by: Bryan Cox <brcox@redhat.com>
Assisted-by: LLM

With scope

feat(azure): add workload identity support

Signed-off-by: Bryan Cox <brcox@redhat.com>
Assisted-by: LLM

Multi-paragraph with footers

fix: prevent racing of requests

Introduce request ID and reference to latest request. Dismiss
incoming responses other than from latest request.

Remove timeouts which were used to mitigate racing but are
obsolete now.

Reviewed-by: Jane Doe
Refs: #123
Signed-off-by: Bryan Cox <brcox@redhat.com>
Assisted-by: LLM

Conventional commit examples

Commit message with description and breaking change footer:

feat: allow provided config object to extend other configs

Signed-off-by: Bryan Cox <brcox@redhat.com>
BREAKING CHANGE: `extends` key in config file is now used for extending other config files

Commit message with ! to draw attention to a breaking change:

feat!: send an email to the customer when a product is shipped

Signed-off-by: Bryan Cox <brcox@redhat.com>

Commit message with scope and ! to draw attention to a breaking change:

feat(api)!: send an email to the customer when a product is shipped

Signed-off-by: Bryan Cox <brcox@redhat.com>

Commit message with both ! and a BREAKING CHANGE footer:

chore!: drop support for Node 6

Signed-off-by: Bryan Cox <brcox@redhat.com>
BREAKING CHANGE: use JavaScript features not available in Node 6.

Commit message with no body:

docs: correct spelling of CHANGELOG

Signed-off-by: Bryan Cox <brcox@redhat.com>

Commit message with scope:

feat(lang): add Polish language

Signed-off-by: Bryan Cox <brcox@redhat.com>

Commit message with a multi-paragraph body and multiple footers:

fix: prevent racing of requests

Introduce a request ID and a reference to the latest request. Dismiss
incoming responses other than from the latest request.

Remove timeouts which were used to mitigate the racing issue but are
obsolete now.

Reviewed-by: Z
Refs: #123
Signed-off-by: Bryan Cox <brcox@redhat.com>

Quick Checklist

When creating commits:

  • Use conventional commit format: <type>(<scope>): <description>
  • Use an imperative subject and explain "Why" and "How" when appropriate
  • Title under 120 characters
  • Body lines under 140 characters
  • Include Signed-off-by footer
  • If an AI assistant helped create or generate the commit message, include Assisted-by: LLM; omit it for human-authored commit messages
  • Validate with make run-gitlint
  • Use ! or BREAKING CHANGE for breaking changes

Reference

Conventional Commits Specification: https://www.conventionalcommits.org/en/v1.0.0/#specification

Source: SKILL.md on GitHub

skilld matched fixed text patterns in SKILL.md and file names. Patterns miss obfuscated code.

skilld run checks every file with the same patterns. It asks for approval before it loads a Skill with a behavior marked Needs approval.

1 warning8d4 checks · Risk SAFE
  • Gen Agent Trust Hub8d

    The skill provides guidelines for formatting git commit messages according to the Conventional Commits specification for the HyperShift project. It includes instructions for populating standard commit footers using local configuration and environment variables, and it suggests validating output with local project tools.

  • Socket8d

    No alerts

  • Snyk25d

    Risk: LOW · No issues

  • Runlayer9mo

    1/1 file flagged

Signed by skilld at 0f43b29. This ties the file your Agent reads to that commit on GitHub. It does not review the instructions.

Last checked against GitHub yesterday.

Activeupdated 2 months ago
  • Git/VCS
  • commits
  • conventional-commits
  • hypershift
  • openshift
  • gitlint
  • formatting

README badge

README badge for openshift/hypershift/git-commit-format

Enforces HyperShift's conventional commit format with required Signed-off-by and Commit-Message-Assisted-by footers, validated via gitlint. Use when generating or creating commits in the HyperShift project to ensure title lines stay under 120 characters and body lines under 140 characters.

Generated from the current SKILL.md.

What footers are required in every commit message?
Two footers are always required: `Signed-off-by` with your name and email (from git config or environment variables), and `Commit-Message-Assisted-by: Claude (via Claude Code)` when Claude generates the message.
What are the character limits for commit messages?
The title line has a maximum of 120 characters, and body lines must not exceed 140 characters per line.
How do I indicate a breaking change?
Use either a `!` after the type (e.g., `feat!:`) or include a `BREAKING CHANGE` footer in the message, or both for clarity.
How do I validate commit messages?
Run `make run-gitlint` to validate that your commit messages meet the HyperShift conventional commit rules and character limits.
What commit types are allowed?
The allowed types are: feat, fix, docs, style, refactor, test, chore, build, ci, perf, and revert. Each type should be followed by an optional scope in parentheses and a description.

Generated from the current SKILL.md. These answers refresh after source changes.