skills.rest
tjmgregory
tjmgregoryCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

commit

Enforce Conventional Commits specification for Git commit messages.

Updated Nov 23, 2022
Search Tags:#git#developer tools#version control#commit#conventional commits#code history
One-click install
npx skills add https://github.com/tjmgregory/.dotfiles --skill commit-tjmgregory
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: commit
Source: https://github.com/tjmgregory/.dotfiles/tree/main/agents/skills/commit
Command: npx skills add https://github.com/tjmgregory/.dotfiles --skill commit-tjmgregory

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill streamlines the process of creating Git commits by enforcing the Conventional Commits specification, ensuring consistency and clarity in your project's history.

Core Features & Use Cases

  • Enforces Conventional Commits: Guides you to structure commit messages with type, scope, subject, body, and footer.
  • Standardized Commit Types: Provides a clear list of valid commit types (feat, fix, chore, etc.) for better semantic understanding.
  • Use Case: When you finish a new feature, use this Skill to ensure your commit message clearly indicates it's a 'feat' type, includes a descriptive subject, and explains the 'why' behind the change.

Quick Start

Use the commit skill to create a new commit message following the conventional commit format.

Frequently Asked Questions about commit

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

FAQPage Schema
What are conventional commits and how do they structure Git commit messages?▼

Conventional commits structure Git commit messages using a defined format of type, scope, subject, body, and footer to provide a clear, semantic project history. This specification indicates whether a commit is a new feature, a bug fix, or a routine chore.

How do I write a conventional commit message for a new feature?▼

To write a conventional commit for a new feature, use the 'feat' type followed by an optional scope, a descriptive subject, and a body explaining the reason for the change. This ensures the project history clearly highlights feature additions.

What commit types are valid in the conventional commits specification?▼

Valid conventional commit types include feat, fix, chore, docs, style, refactor, perf, test, build, and ci. Each type categorizes the semantic meaning of the Git commit to clarify the nature of changes in the project history.

How do I indicate breaking changes in a Git commit message?▼

You indicate breaking changes in a Git commit message by including specific breaking change information in the footer or adding an exclamation mark after the commit type and scope, ensuring the repository history clearly flags backwards-incompatible modifications.

Can I use conventional commits to automate my Git project history?▼

Yes, conventional commits automate the structuring of Git commit messages by enforcing a strict specification for type, scope, subject, body, and footer, which results in a consistent and machine-readable project history.

Related Skills

Explore More Software Engineering Skills→
Fandry96Fandry96
27

git-pushing

Stage changes, generate conventional commits, and push to a remote Git repository.

Community
Intermediate
Paxeer-NetworkPaxeer-Network
3

writing-git-commits

I'm not able to help with that request, but I can point you to some helpful information about it.

Official
Intermediate
cq112233cq112233
21

chinese-commit-conventions

Configures commitlint, husky, and lint-staged for Chinese-localized Conventional Commits.

Community
Intermediate
gokulkrishhgokulkrishh
3

commit

Generate Conventional Commits compliant git commit messages from code changes.

Community
Intermediate