Agent skill

Pre PR Checklist

by oocx in oocx/tfplan2md

Minimum-requirements checklist for any change — code or docs-only.

MITAuto-check passedDevelopment

Install Pre PR Checklist

skills CLI
$ npx skills add oocx/tfplan2md --skill pre-pr-checklist -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install oocx/tfplan2md pre-pr-checklist --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/oocx/tfplan2md.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.agents/skills/pre-pr-checklist .claude/skills/pre-pr-checklist && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
pre-pr-checklist
GitHub stars
174
Token cost
~1.8k tokens
SKILL.md length
567 words
Files
1
Skills in repo
28
Repo updated
First seen
Licence
MIT

At a glance

Minimum-requirements checklist for any change — code or docs-only.

  • Works in 9 steps: Determine Your Change Category → Work Item Folder → Code Formatting → …
  • Tasks that involve Failing and flaky tests
  • SKILL.md covers Purpose, When to Use, Step 0 — Determine Your Change… and Step 1 — Work Item Folder, plus 8 more sections
  • Calls dotnet, git and npx

What it does

Pre PR Checklist is an agent skill from oocx/tfplan2md. Minimum-requirements checklist for any change — code or docs-only. Run this before every PR creation or push to avoid CI failures on the first attempt.

Its SKILL.md is about 1.8k tokens, which your agent loads only when the skill is triggered. It is a single SKILL.md file with no bundled scripts.

It sits in Development, covering Failing and flaky tests. The repository describes itself as: Convert terraform plans (json) into human readable markdown for easier review of changes in pull requests. The licence is MIT.

When your agent uses it

  • Tasks that involve Failing and flaky tests

Example prompts

  • “/pre-pr-checklist”

Requirements

  • Node.js

Workflow steps

9 steps, taken from the step headings in SKILL.md.

  1. Determine Your Change Category
  2. Work Item Folder
  3. Code Formatting
  4. Build
  5. Tests and Coverage
  6. Demo Artifact Regeneration
  7. Commit Hygiene
  8. Local Guardrail Scripts
  9. PR Title and Description

What it can do on your machine

Read from SKILL.md and the folder at commit 88d5240. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    Shell commands in SKILL.md call:

    • dotnet
    • git
    • npx
    • node

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    Links to these hosts (documentation or services it may open):

    • conventionalcommits.org

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Pre PR Checklist loads about 1.8k tokens when it runs. Until then it costs about 42 tokens; SKILL.md has 567 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~42
When it runs · the whole SKILL.md, loaded when a task matches
~1.8k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from oocx/tfplan2md at commit 88d5240, republished under its MIT licence (© oocx). 567 words, ~1,800 tokens.

Download SKILL.mdSave it as .claude/skills/pre-pr-checklist/SKILL.md (or your agent's skills folder).
name
pre-pr-checklist
description
Minimum-requirements checklist for any change — code or docs-only. Run this before every PR creation or push to avoid CI failures on the first attempt.

Pre-PR Checklist

Purpose

Ensure every change — including simple, single-agent tasks — satisfies the repository's minimum requirements before a PR is created. This avoids predictable CI failures (release-notes guardrail, snapshot guardrail, formatting, coverage thresholds).

When to Use

Mandatory before any report_progress call (coding agents) or scripts/pr-github.sh create call (local agents) that introduces changes to the repository.

Step 0 — Determine Your Change Category

bash
git diff --name-only origin/main...HEAD

Category A — Docs/agent-tooling only (all changed files are under docs/ except docs/workflow.md and docs/spec.md, .github/ or .agents/ (any subdirectory or file), website/, website.old/, assets/, tests/, scripts/, or src/tests/shell/): → Skip to Step 6 (Commit hygiene). Build/test/work-item checks are not required.

Category B — Code/tooling (any file in src/ (except src/tests/shell/), examples/, docs/workflow.md, docs/spec.md, README.md, or CONTRIBUTING.md): → Complete all steps below.


Step 1 — Work Item Folder

Every code/tooling PR must be anchored to a work item folder. If you are doing a simple task without a full workflow, create a minimal one now.

Determine the folder
Branch prefixFolder prefix
feature/<NNN>-...docs/features/<NNN>-.../
fix/<NNN>-...docs/issues/<NNN>-.../
workflow/<NNN>-...docs/workflow/<NNN>-.../

If the branch does not match any prefix, use docs/workflow/ (most internal/tooling changes fall here). Use the next-issue-number skill to reserve an issue number if you don't already have one.

Create minimal required files (if missing)

docs/<type>/<NNN>-<slug>/release-notes.md — describe the change in one or two sentences. No screenshots required for simple changes:

markdown
## <Short title>

<One or two sentences describing what changed and why.>

docs/<type>/<NNN>-<slug>/work-protocol.md — log your agent entry (required by the validate-work-protocol hook):

markdown
# Work Protocol: <Short title>

**Work Item:** `docs/<type>/<NNN>-<slug>/`
**Branch:** `<branch-name>`
**Workflow Type:** <Feature | Bug Fix | Workflow>
**Created:** <YYYY-MM-DD>

## Agent Work Log

### <Your Agent Name>
- **Date:** <YYYY-MM-DD>
- **Summary:** <What you did>
- **Artifacts Produced:** <Files created or modified>
- **Problems Encountered:** None

Note: For simple single-agent changes the validate-work-protocol hook only blocks report_progress after the trigger agent (Code Reviewer for features/bugs; Workflow Engineer for workflow items) has logged an entry. So for single-agent tasks the hook will not block you — but the release-notes guardrail (validate-release-notes.sh) will. Both release-notes.md and work-protocol.md must be present.


Step 2 — Code Formatting

bash
dotnet format src/tfplan2md.slnx --verify-no-changes --verbosity diagnostic

If formatting errors are found, auto-fix and re-check:

bash
dotnet format src/tfplan2md.slnx
dotnet format src/tfplan2md.slnx --verify-no-changes

Step 3 — Build

bash
dotnet build src/tfplan2md.slnx --configuration Release --no-incremental

All errors must be resolved before proceeding.


Step 4 — Tests and Coverage

Use the run-dotnet-tests skill. The project has mandatory coverage thresholds (84.48 % line, 72.80 % branch). New code must be tested.

bash
scripts/test-with-timeout.sh -- dotnet test --solution src/tfplan2md.slnx --configuration Release
Snapshot changes

If any file under src/tests/Oocx.TfPlan2Md.Tests/TestData/Snapshots/ changed, use the update-test-snapshots skill and include SNAPSHOT_UPDATE_OK in at least one commit message:

bash
git commit --amend -m "$(git log -1 --format=%B)

SNAPSHOT_UPDATE_OK"

Show full SKILL.md (225 more words)Show less

Step 5 — Demo Artifact Regeneration

Required when any change could affect markdown rendering output:

bash
node -e "require('child_process').execSync('dotnet run --project src/Oocx.TfPlan2Md/Oocx.TfPlan2Md.csproj -- examples/comprehensive-demo/plan.json --principals examples/comprehensive-demo/demo-principals.json --output artifacts/comprehensive-demo.md', {stdio: 'inherit'})"
npx markdownlint-cli2 artifacts/comprehensive-demo.md

Or more directly:

bash
dotnet run --project src/Oocx.TfPlan2Md/Oocx.TfPlan2Md.csproj -- examples/comprehensive-demo/plan.json --principals examples/comprehensive-demo/demo-principals.json --output artifacts/comprehensive-demo.md
npx markdownlint-cli2 artifacts/comprehensive-demo.md

Skip this step only if the change has no effect on markdown output (e.g., internal refactoring with no observable output change, or pure tooling/docs changes).


Step 6 — Commit Hygiene

Before creating the PR, verify:

  • All commits follow Conventional Commits: type(scope): description
    • Valid types: feat, fix, docs, style, refactor, perf, test, build, ci, chore, revert, workflow
    • For internal-only PRs (docs/scripts/agents only), use workflow:, docs:, chore:, ci:, style:, or refactor: — not feat:, fix:, or perf: (those trigger version bumps)
  • CHANGELOG.md has not been edited (it is auto-generated by Versionize in CI)
  • Working tree is clean: git status --short

Step 7 — Local Guardrail Scripts

Run the same checks that CI will run, locally:

bash
# Release notes guardrail
scripts/validate-release-notes.sh

# Snapshot integrity guardrail
scripts/validate-snapshot-changes.sh

Both scripts default to comparing against origin/main. Fix any reported errors before pushing.


Step 8 — PR Title and Description

Before calling report_progress or scripts/pr-github.sh create, compose the PR title and description using the standard template:

markdown
## Problem
<Why is this change needed?>

## Change
<What changed?>

## Verification
<How was it validated? List the checks you ran from this checklist.>

Quick Reference (Category B)

StepCommand / Action
Work item folderCreate release-notes.md + work-protocol.md with agent log entry
Formatdotnet format src/tfplan2md.slnx --verify-no-changes
Builddotnet build src/tfplan2md.slnx --configuration Release --no-incremental
Testsscripts/test-with-timeout.sh -- dotnet test --solution src/tfplan2md.slnx
SnapshotsUse update-test-snapshots skill; add SNAPSHOT_UPDATE_OK to commit
Demodotnet run ... -- examples/comprehensive-demo/plan.json ... --output artifacts/comprehensive-demo.md
Lint demonpx markdownlint-cli2 artifacts/comprehensive-demo.md
Guardrailsscripts/validate-release-notes.sh + scripts/validate-snapshot-changes.sh
CommitsConventional Commits, no CHANGELOG.md edits

© oocx, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

Just SKILL.md in .agents/skills/pre-pr-checklist of oocx/tfplan2md.

Open the folder on GitHubat commit 88d5240

Compare with similar skills

Pre PR Checklist next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Pre PR Checklist compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Pre PR Checklist this skilloocx/tfplan2md174—~1.8kAutomated safety check: PassMIT
PR Babysitteropeninterpreter/openinterpreter69k3 repos~4.2kAutomated safety check: PassApache-2.0
Releasingc15t/c15t1.9k—~753Automated safety check: PassApache-2.0
CI Fixwarpdotdev/oz-skills825—~790Automated safety check: PassMIT
Fix CIccusage/ccusage19k—~487Automated safety check: PassCustom licence
Nx CI Monitortech-leads-club/agent-skills7k—~5.3kAutomated safety check: PassCustom licence

Similar skills

  • PR Babysitter

    openinterpreter/openinterpreter

    Watches an open GitHub pull request until it merges, handling review comments, diagnosing CI failures and retrying flaky checks along the way.

    69k GitHub starsUsed in 3 repos~4.2k tokens
    DevelopmentAuto-check passed
  • Releasing

    c15t/c15t

    Version and release c15t packages with Changesets. An agent skill from c15t/c15t.

    1.9k GitHub stars~753 tokensUpdated today
    DevelopmentAuto-check passed
  • CI Fix

    warpdotdev/oz-skills

    Diagnose and fix GitHub Actions CI failures. An agent skill from warpdotdev/oz-skills.

    825 GitHub stars~790 tokensUpdated 1 mo ago
    DevelopmentAuto-check passed
  • Fix CI

    ccusage/ccusage

    Diagnoses and fixes failing GitHub Actions checks with gh. An agent skill from ccusage/ccusage.

    19k GitHub stars~487 tokensUpdated today
    DevelopmentAuto-check passed
  • Nx CI Monitor

    tech-leads-club/agent-skills

    Monitor Nx Cloud CI pipeline status and handle self-healing fixes automatically.

    7k GitHub stars~5.3k tokensUpdated today
    DevelopmentAuto-check passed
  • Unblock Dependabot PR

    kubernetes-sigs/cloud-provider-azure

    Official

    Diagnose and unblock failed Dependabot pull requests in cloud-provider-azure by closing Kubernetes minor-version dependency bumps, classifying CI failures, syncing Go modules, retesting quota-flaked…

    294 GitHub stars~1.5k tokensUpdated today
    DevelopmentAuto-check passed

More from oocx/tfplan2md

All 28 skills in this repo
  • Create Agent Skill

    oocx/tfplan2md

    Create a new Agent Skill following project standards and templates.

    174 GitHub stars~1.5k tokensUpdated yesterday
    Auto-check passed
  • Detect and analyze edge crossings and overlaps in SVG workflow diagrams using geometric intersection algorithms and visual analysis.

    174 GitHub stars~4.3k tokensUpdated yesterday
    Auto-check passed
  • Generate PNG screenshots for release notes using the repository's HtmlRenderer and ScreenshotGenerator tools.

    174 GitHub stars~3.7k tokensUpdated yesterday
    Auto-check passed
  • Git Rebase Main

    oocx/tfplan2md

    Safely rebase the current feature branch on top of the latest origin/main.

    174 GitHub stars~456 tokensUpdated yesterday
    Auto-check passed
  • Next Issue Number

    oocx/tfplan2md

    Determine the next available issue number across all change types (feature, fix, workflow, website) by checking both local docs and remote branches, then reserve it by pushing an empty branch.

    174 GitHub stars~1.5k tokensUpdated yesterday
    Auto-check passed
  • Run Uat

    oocx/tfplan2md

    Run User Acceptance Testing by creating a PR with rendered markdown on GitHub or Azure DevOps.

    174 GitHub stars~1.2k tokensUpdated yesterday
    Auto-check passed

Questions about Pre PR Checklist

What does Pre PR Checklist do?

Minimum-requirements checklist for any change — code or docs-only. Pre PR Checklist is an agent skill from oocx/tfplan2md. Minimum-requirements checklist for any change — code or docs-only.

When should I use Pre PR Checklist?

Pre PR Checklist fits situations like: tasks that involve Failing and flaky tests.

How do I install Pre PR Checklist in Claude Code?

Run `npx skills add oocx/tfplan2md --skill pre-pr-checklist -a claude-code`. Or copy the skill folder (.agents/skills/pre-pr-checklist in oocx/tfplan2md) into .claude/skills/pre-pr-checklist in your project. Claude Code loads it when a task matches its description.

How do I install Pre PR Checklist in Codex?

Run `npx skills add oocx/tfplan2md --skill pre-pr-checklist -a codex`. Or copy the skill folder (.agents/skills/pre-pr-checklist in oocx/tfplan2md) into .agents/skills/pre-pr-checklist in your project. Codex loads it when a task matches its description.

Can I use Pre PR Checklist in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add oocx/tfplan2md --skill pre-pr-checklist -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/pre-pr-checklist, .gemini/skills/pre-pr-checklist, .github/skills/pre-pr-checklist and .opencode/skills/pre-pr-checklist in your project.

What does Pre PR Checklist need to run?

Going by SKILL.md and its folder, Pre PR Checklist needs the command-line tools its instructions call (dotnet, git, npx and node). Our summary lists: Node.js.

Does Pre PR Checklist access the network?

SKILL.md names 1 domain. As links in the text: conventionalcommits.org. This is read from the text; nothing was executed.

Is Pre PR Checklist safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Pre PR Checklist use?

Pre PR Checklist is published under the MIT licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Pre PR Checklist use?

About 1.8k tokens (SKILL.md is roughly 7.2k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to Pre PR Checklist?

Skills that share tags, products or a category with Pre PR Checklist: PR Babysitter (openinterpreter/openinterpreter, 69k stars), Releasing (c15t/c15t, 1.9k stars), CI Fix (warpdotdev/oz-skills, 825 stars) and Fix CI (ccusage/ccusage, 19k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Pre PR Checklist?

oocx (a GitHub user) maintains it in oocx/tfplan2md, which has 174 GitHub stars. The repository holds 28 skills in this directory. The repository was last updated on October 7, 2026.

Source: oocx/tfplan2md on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.