pr-checklist

Validates pull request readiness against project contribution rules before opening a PR.

104|25|Updated Jan 28, 2026
One-click install
npx skills add https://github.com/Swttch/swttch --skill pr-checklist-swttch
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: pr-checklist
Source: https://github.com/Swttch/swttch/tree/main/.claude/skills/pr-checklist
Command: npx skills add https://github.com/Swttch/swttch --skill pr-checklist-swttch

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Opening a pull request without verifying rebase state, tests, documentation, and project conventions leads to rejected reviews, broken CI, and rework. This Skill runs a structured pre-PR verification checklist for the Swttch (claude-code-gui-jetbrains) repository so every requirement is checked with real commands before the PR is opened. ## Core Features & Use Cases - Rebase and commit hygiene checks: Verifies the branch is rebased onto the latest main and that every commit title stays within the 72-character limit. - Feature documentation enforcement: Confirms feature PRs include per-language docs under docs/features/ with screenshots when UI is involved. - Marketplace API compliance: Greps the Kotlin source for forbidden JetBrains Internal or Deprecated APIs that would fail the Marketplace Plugin Verifier. - Three-layer test gate: Runs WebView, Backend, and Kotlin test/lint/build layers via the project's build script. - Use Case: Before opening a PR for a new chat feature, run the checklist to confirm the branch is rebased, docs/features/ contains en.md and ko.md with screenshots, no Internal APIs are used, all three test layers pass, and the PR body includes a closing flag like Closes #N. ## Quick Start Ask the assistant to run the pre-PR checklist on the current branch before opening a pull request.

Frequently Asked Questions about pr-checklist

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

FAQPage Schema
How do I check if my branch is ready for a pull request?

Run a pre-PR checklist that verifies the branch is rebased onto the latest main, all tests pass, commit titles are within length limits, and required documentation exists. This Skill automates each check with concrete commands and reports PASS or FAIL per item.

How to verify a JetBrains plugin avoids forbidden Internal APIs?

Grep the Kotlin source for @ApiStatus.Internal annotations and impl package classes, since the Marketplace Plugin Verifier rejects plugins using them. Deprecated APIs should also be avoided or routed through reflection or public alternatives.

What documentation is required for a feature pull request?

Feature PRs need a docs/features/NNN-feature_name/ folder with per-language files like en.md and ko.md, plus an index entry. If the UI is involved, screenshots stored in the feature's assets folder are mandatory.

Why does my commit get rejected with a message length error?

A local commit-msg hook rejects titles over 72 characters. Measure the title before committing, and if a commit is too long, move detail into the body or split the commit rather than shortening ambiguously.

Does the PR body need a closing keyword for linked issues?

Yes, use explicit closing flags like Closes #N or Fixes #N in the PR body. A plain (#N) reference does not auto-close the issue, so amend the commit before pushing if the flag is missing.