git-best-practices

What problem does it solve?

This Skill eliminates vague or incomplete commit messages that hinder code review, debugging, and understanding project history, leading to wasted time and increased technical debt.

Core Features & Use Cases

• Comprehensive Commit Structure: Enforces a detailed header (type, scope, description) and a mandatory body explaining the problem, root cause, solution, and changes for fixes, or an overview, components, and implementation for features.
• Pre-Commit Verification: Guides you to always verify changes using git status and git diff --staged before generating any commit message, ensuring accuracy and completeness.
• Detailed Requirements by Type: Provides specific content requirements for different commit types (feat, fix, refactor, docs), ensuring all necessary context is captured.
• Use Case: After staging your changes, activate this skill to generate a professional, detailed commit message that tells the complete story of your modifications, making future code reviews and debugging effortless.

Quick Start

Example: Feature commit message

feat(auth): add JWT token validation

New Functionality: Implement JWT validation middleware with token expiry checking and refresh token support.

Changes:

• Created jwt-middleware.ts
• Updated auth-service.ts to use middleware

Impact: Enhances security and session management.