commit skill

Overview

This skill helps you create clean, consistent git commits for a dotfiles repository managed with yadm. It guides commit message format and enforces rules such as excluding AI attributions and Co-Authored-By headers. Use it to keep history readable and policy-compliant.

How this skill works

The skill inspects staged changes and suggests a concise commit message that reflects the scope and intent of the changes. It applies repository conventions for subject lines and body content, and flags disallowed text like AI attributions or Co-Authored-By trailers before finalizing the commit.

When to use it

• Committing configuration or dotfile changes in the yadm-managed repository
• When you want a clear, policy-compliant commit message
• Preparing commits for review or synchronization across machines
• After staging multiple related changes that need a single, focused commit

Best practices

• Write a short imperative subject line (50 characters or fewer) summarizing the change
• Include a brief body if additional context is needed, wrapped at ~72 characters
• Group related changes into a single commit and avoid mixing unrelated fixes
• Do not add AI or assistant attribution text anywhere in the commit message
• Never include Co-Authored-By headers; use explicit author information only if required

Example use cases

• Update shell prompt configuration and commit with subject 'update: improve PS1 prompt'
• Add a new gitconfig alias and provide a body explaining why the alias helps
• Fix a syntax error in the vimrc and commit with a focused message 'fix(vim): correct mapping for <leader>t'
• Rename a dotfile and commit with a clear subject and body describing migration steps

FAQ