commit-code

Commit code changes with standardized messages and safe push procedures.

Updated Mar 17, 2023
One-click install
npx skills add https://github.com/IainMcl/dotfiles --skill commit-code-iainmcl
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: commit-code
Source: https://github.com/IainMcl/dotfiles/tree/main/claude/skills/commit-code
Command: npx skills add https://github.com/IainMcl/dotfiles --skill commit-code-iainmcl

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill provides clear guidelines and a structured process for committing code changes, ensuring consistency and clarity in your version control history.

Core Features & Use Cases

  • Commit Message Formatting: Enforces a specific format for commit titles and descriptions.
  • Pre-commit Hook Handling: Guides users on how to proceed if pre-commit hooks modify files.
  • Safe Pushing: Details the correct procedures for pushing changes upstream, including force-pushing with lease.
  • Use Case: When you've finished a feature or bug fix, use this Skill to ensure your commit message is clear, concise, and follows best practices before pushing to the remote repository.

Quick Start

Use the commit-code skill to write your commit message to /tmp/commit_msg.txt and then commit using that file.

Frequently Asked Questions about commit-code

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

FAQPage Schema
How do I format git commit messages for a clean version control history?

To format git commit messages properly, adhere to specific rules for commit titles and descriptions to maintain a clean and informative Git history. This ensures consistency and clarity across your version control commits.

What should I do if pre-commit hooks modify files during a git commit?

If pre-commit hooks modify files during a git commit, you should follow specific guidelines to handle the modified files before proceeding. This ensures your committed code changes reflect the automated formatting and pass all hook validations.

What is the safest way to push code changes upstream after a git rebase?

The safest way to push code changes upstream after a git rebase is to use the `--force-with-lease` flag. This safe pushing practice prevents accidentally overwriting remote commits that you may not have locally.

How do I use this process to write and apply my git commit message?

To use this process, write your standardized git commit message to the `/tmp/commit_msg.txt` file and then commit using that file. This ensures your commit titles and descriptions follow the required rules.

Do I need any specific dependencies installed to manage my git commits this way?

No, you do not need any specific dependencies installed to manage your git commits this way. The process provides standalone instructions for committing code changes, requiring no additional modules or external component setups.