skills.rest
toqoz
toqozCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

commit-staged

Commit staged git changes with Conventional Commits and branch protection.

Updated Oct 15, 2021
Search Tags:#automation#git#workflow#commit#version-control#conventional-commits
One-click install
npx skills add https://github.com/toqoz/config --skill commit-staged-toqoz
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: commit-staged
Source: https://github.com/toqoz/config/tree/main/home/agents/skills/commit-staged
Command: npx skills add https://github.com/toqoz/config --skill commit-staged-toqoz

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill solves the problem of inconsistent or poorly formatted git commit messages by enforcing the Conventional Commits standard while ensuring only the intended, staged changes are included in the commit.

Core Features & Use Cases

  • Conventional Commit Enforcement: Automatically guides the creation of structured commit messages with types like feat, fix, and refactor.
  • Safety Guardrails: Prevents accidental commits to protected branches like main or production unless explicitly authorized.
  • Integrated Workflow: Supports optional automated pushing and pull request creation via the GitHub CLI.
  • Use Case: Use this when you have finished a specific feature or bug fix and want to commit only those changes with a professional, descriptive message that follows team standards.

Quick Start

Ask the assistant to commit the staged changes with a descriptive message explaining the recent updates.

Frequently Asked Questions about commit-staged

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

FAQPage Schema
How do I commit staged changes using conventional commits?▼

You can automate conventional commit creation by asking the assistant to commit your staged changes with a descriptive message. The skill validates the git index and enforces conventional commit standards automatically.

What are conventional commits and when do I need them for git workflow?▼

Conventional commits are a standardized message format for git history, using types like feat, fix, and refactor. You need them to ensure consistent, professional commit messages that follow team standards when finalizing a specific bug fix or feature.

Do I need GitHub CLI installed to automate git commits and pull requests?▼

Yes, you need both git and the GitHub CLI installed and authenticated in your local environment. The GitHub CLI is required for optional remote synchronization and pull request creation features integrated into the commit workflow.

Can I use this to commit directly to protected branches like main or production?▼

No, the skill includes safety guardrails that prevent accidental commits to protected branches like main or production. It enforces branch protection rules unless you explicitly authorize the commit to bypass these restrictions.

What is the best way to automate pushing and creating a pull request after committing?▼

The best way to automate pushing and pull request creation is to use an integrated workflow skill that leverages the GitHub CLI. This allows you to commit staged changes and optionally automate remote synchronization in one step.

Related Skills

Explore More Software Engineering Skills→
alunadevalunadev
3

deploying-to-github

Automate Git commits and pushes to GitHub repositories with conventional prefixes.

Community
Basic
VYRE-StudiosVYRE-Studios

commit-push-pr

Commit staged changes, push the branch, and open a pull request via GitHub CLI.

Official
Intermediate
t0labt0lab
2

git-conventional

Enforce Conventional Commits formatting and map commit types to semantic version bumps.

Official
Basic
ArogyaReddyArogyaReddy

changelog-automation

Generate changelogs from commits and PRs using Keep a Changelog and Conventional Commits.

Community
Advanced