pr-commit-workflow
This skill should be used when creating commits or pull requests, enforcing a human-written PR structure, intent capture, and evidence in agentic workflows.
When & Why to Use This Skill
The pr-commit-workflow skill is designed to standardize and enhance the version control process within agentic coding environments. It enforces high-signal commit messages and structured, human-written pull request (PR) formats to ensure clarity, intent capture, and verifiable evidence. By bridging the gap between AI-driven code generation and professional engineering standards, it maintains repository integrity and facilitates efficient human code reviews.
Use Cases
- Standardizing Git Commits: Automatically enforcing specific commit message formats and checklists to maintain a clean and searchable repository history during AI-assisted development.
- Enforcing Human-Centric PR Descriptions: Ensuring that pull requests contain genuine human intent rather than AI-generated summaries, preventing the loss of context in complex code changes.
- Automated Evidence Collection: Using integrated scripts to gather environment metadata and execution logs, providing reviewers with immediate proof of work and testing results.
- Streamlining Agentic Workflows: Providing a decision tree for AI agents to handle commit-only tasks versus full PR lifecycles, ensuring consistent behavior across different development scenarios.
- GitHub CLI Integration: Automating the creation and updating of PR bodies using the GitHub CLI (gh pr) while adhering to strictly defined local templates.
| name | pr-commit-workflow |
|---|---|
| description | This skill should be used when creating commits or pull requests, enforcing a human-written PR structure, intent capture, and evidence in agentic workflows. |
PR + Commit Workflow
Overview
Enforce a high-signal commit workflow and a human-written PR format. Keep global process rules as source of truth and make PRs reviewable by humans and agents.
Workflow Decision Tree
- If the task is about commits only, follow
references/workflow-commit.md. - If the task involves PR creation or PR updates, follow
references/workflow-pr.md.
Global Rules
- If the repo has
AGENTS.mdordocs/agents/PROCESS.md, read it for repo-specific rules. - Require user-supplied, human-written intent for every PR. Never generate or paraphrase this text.
- Use
/tmpfor PR body drafts andgh pr edit --body-filefor updates.
Commit Workflow (entry point)
- Execute the steps in
references/workflow-commit.md. - Use the message format in
references/commit-format.md.
PR Workflow (entry point)
- Execute the steps in
references/workflow-pr.md. - Use the template in
references/pr-human-template.mdverbatim. - Use
scripts/build_pr_body.shto gather environment metadata if available.
Resources
references/workflow-commit.md: commit checklist and evidence expectations.references/workflow-pr.md: PR creation/update flow, comment checks, and evidence rules.references/pr-human-template.md: human-written PR structure (must be used as-is).references/commit-format.md: commit message format and examples.scripts/build_pr_body.sh: environment metadata collector for PR prompt history section.