commit

Guide Git commits with compilation, testing, and Conventional Commits messages.

Updated Jun 26, 2022
One-click install
npx skills add https://github.com/evengul/mc-org --skill commit-evengul
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: commit
Source: https://github.com/evengul/mc-org/tree/main/.claude/skills/commit
Command: npx skills add https://github.com/evengul/mc-org --skill commit-evengul

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill automates the process of committing code changes, ensuring consistency, quality, and adherence to project standards.

Core Features & Use Cases

  • Guided Workflow: Follows a step-by-step process for compiling, testing, reviewing, and committing code.
  • Quality Assurance: Enforces pre-commit checks and standard commit message formatting.
  • Use Case: When you've finished a feature, use this Skill to ensure your code compiles, tests pass, and your commit message follows the Conventional Commits standard, including closing relevant issues.

Quick Start

Use the commit skill to prepare and finalize your code changes for a new commit.

Frequently Asked Questions about commit

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

FAQPage Schema
How do I automate my Git commit workflow to include testing and code review?

Automating your Git commit workflow involves a structured process that compiles code, runs tests, performs pre-commit checks, and formats commit messages to Conventional Commits standards while closing relevant issues.

What is the Conventional Commits standard for structuring Git commit messages?

Conventional Commits is a specification for creating standardized commit messages, ensuring consistency and quality by enforcing a specific format that integrates seamlessly with issue tracking notations.

How do I link a Git commit to a project issue using the Closes notation?

Linking a Git commit to an issue uses the "Closes MCO-XXX" notation within the commit message, automatically integrating the commit with the project's issue tracking system.

What is the best way to ensure code compiles and tests pass before committing?

The best way to ensure code compiles and tests pass is following a guided pre-commit checklist that systematically verifies compilation, executes tests, and enforces code review before finalizing the commit.

What pre-commit checklist should I follow for a structured Git workflow?

A pre-commit checklist for a structured Git workflow should verify code compilation, ensure tests pass, enforce code review standards, and validate that commit messages follow Conventional Commits formatting.

Does the Conventional Commits format work with existing issue tracking workflows?

Yes, Conventional Commits integrates with issue tracking workflows by appending notations like "Closes MCO-XXX" to commit messages, linking code changes directly to tracked issues.