Get the FREE Ultimate OpenClaw Setup Guide →
npx machina-cli add skill athola/claude-night-market/pr-prep --openclaw
Files (1)
SKILL.md
5.3 KB

Pull Request Preparation Workflow

Usage

Use this skill to stage changes and generate a PR summary. Run Skill(sanctum:git-workspace-review) first to capture the repository state and diffs.

Required Progress Tracking

Create TodoWrite items for these steps before starting:

  1. pr-prep:workspace-reviewed
  2. pr-prep:quality-gates
  3. pr-prep:changes-summarized
  4. pr-prep:testing-documented
  5. pr-prep:pr-drafted
  6. pr-prep:content-verified

Mark each item as complete as the section is finished.

Step 1: Review Workspace (workspace-reviewed)

Confirm that Skill(sanctum:git-workspace-review) is complete. If changes were staged after the initial review, re-execute the skill to refresh the context.

Step 2: Run Quality Gates (quality-gates)

Execute formatting, linting, and tests using project-specific commands (e.g., make fmt, make lint, make test). Resolve all failures before proceeding. If a task cannot be executed locally, document the reason and the alternative validation performed. Language-specific commands and failure handling are detailed in modules/quality-gates.md.

Step 3: Summarize Changes (changes-summarized)

Use the notes from the workspace review and the output of git diff --stat origin/main...HEAD to understand the scope. Identify key points in the diffs and group them into 2-4 paragraphs highlighting the technical changes and their rationale. Note breaking changes, migrations, or documentation updates.

Step 4: Document Testing (testing-documented)

List each test command executed and its result. Include manual verification steps where relevant. If tests were skipped, document the reason and the mitigation plan.

Step 5: Draft the PR (pr-drafted)

Populate the standard template with Summary, Changes, Testing, and Checklist sections. Include issue references, screenshots, or follow-up TODO items. Template structure and examples are available in modules/pr-template.md.

Step 6: Verify Content Quality (content-verified)

Apply Skill(scribe:slop-detector) principles to the draft. Verify that the PR description avoids tier-1 slop words (delve, comprehensive, leverage, utilize, robust, seamless) and formulaic phrases like "I'd be happy to" or "It should be noted." Ensure there is no AI attribution in the text and that all claims are grounded with evidence such as commands, numbers, or filenames. Use active voice and maintain a balanced structure with prose for context.

Vocabulary Substitutions

  • Replace leverage or utilize with use.
  • Replace comprehensive with thorough or complete.
  • Replace robust with solid or reliable.
  • Replace facilitate with help or enable.
  • Replace streamline with simplify.

Remediation

If the description contains slop, apply Skill(scribe:doc-generator) principles to ground claims with specifics, remove marketing language, and use direct statements.

Output Instructions

Write the final PR description to the specified path, then display the file path and its contents for confirmation.

Notes

Do not include tool or AI attribution in the PR text. If changes are required mid-process, re-run quality gates. This skill covers preparation; pushing changes and opening the PR occurs outside this workflow.

Supporting Modules

Troubleshooting

If project-specific commands like make or npm are unavailable, verify the environment setup against the README. For permission errors, check write access to build directories. If a step fails without clear output, retry the command with verbose flags to inspect the logs.

Source

git clone https://github.com/athola/claude-night-market/blob/master/plugins/sanctum/skills/pr-prep/SKILL.mdView on GitHub

Overview

pr-prep guides you through staging changes, running quality gates, and drafting PR descriptions and templates so submissions are consistent and ready for review. It emphasizes a structured workflow from workspace review to quality checks and changes narratives. Do not use this for reviewing existing PRs; use pr-review instead.

How This Skill Works

pr-prep uses PreToolUse to log quality-gate activity and a PostToolUse hook to track PR template generation. It relies on TodoWrite items for six steps: workspace-reviewed, quality-gates, changes-summarized, testing-documented, pr-drafted, and content-verified. It expects project-specific commands (e.g., make fmt, make lint, make test) as detailed in modules/quality-gates.md and pr-template.md to standardize output.

When to Use It

  • Before submitting a new PR with staged changes
  • When preparing PR descriptions and templates for a submission
  • When validating formatting, linting, and tests via quality gates
  • When summarizing changes for reviewers and maintainers
  • When documenting tests and verification steps in the PR

Quick Start

  1. Step 1: Review Workspace — ensure sanctum:git-workspace-review is complete and refresh context if changes were staged after the initial review
  2. Step 2: Run Quality Gates and Summarize Changes — execute make fmt, make lint, make test; run git diff --stat origin/main...HEAD and craft 2-4 paragraph summary
  3. Step 3: Draft PR and Verify Content — populate the PR template, then apply content-verified checks (slop-detector) before submission

Best Practices

  • Start with workspace-reviewed completion from sanctum:git-workspace-review
  • Run and fix all quality gates (fmt, lint, test) locally as per modules/quality-gates.md
  • Summarize changes in 2-4 paragraphs from diffs origin/main...HEAD
  • Document tests and their results in the PR
  • Draft the PR using the standard template and verify content quality (avoid slop words)

Example Use Cases

  • PR for a new feature with multiple files changed, including a changelog entry and tests
  • Bug fix PR with migration notes and updated docs
  • Dependency update PR with release notes and impact assessment
  • Refactor PR with breaking changes and migration guide
  • Docs and tests PR updating documentation and test coverage

Frequently Asked Questions

Add this skill to your agents

Related Skills

Sponsor this space

Reach thousands of developers