Overview

This skill provides a practical guide for basic Git operations focused on committing changes. It explains crafting English commit messages, structuring a concise first-line summary, and adding detailed bullet points, plus pre-commit checks with mise run fmt and mise run test.

How This Skill Works

When committing, ensure the first line is a concise summary in English. If more detail is needed, insert a blank line after the first line and describe them in bullet points. Before committing, run mise run fmt to format code and mise run test to verify tests pass, ensuring clean, standardized commits.

When to Use It

• After coding on a feature or bugfix branch and preparing to commit
• When you need concise, English commit messages for collaboration
• Before pushing to a shared repository to ensure formatting and tests pass
• When documenting changes to aid future maintainers with a clear history
• When enforcing a standardized commit style across a project

Quick Start

1. Step 1: Ensure you are on the correct feature branch with a clean working tree
2. Step 2: Write a concise English first-line summary; add details after a blank line if needed
3. Step 3: Run mise run fmt and mise run test, then commit the changes

Best Practices

• Commit messages must be written in English
• Use a concise first-line summary that describes the change
• Insert a blank line after the first line and describe details in bullet points if needed
• Keep detailed descriptions to bullet points after the summary
• Run mise run fmt and mise run test before committing

Example Use Cases

• Fix login timeout bug
• Add unit tests for user registration
• Refactor API client error handling
• Format codebase with mise run fmt
• Update documentation to reflect commit guidelines

Frequently Asked Questions