lfx-self-serve-pr-readiness

Audits local git branches for PR-shape compliance before opening pull requests.

12|6|Updated Jul 14, 2025
One-click install
npx skills add https://github.com/linuxfoundation/lfx-self-serve --skill lfx-self-serve-pr-readiness-linuxfoundation
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: lfx-self-serve-pr-readiness
Source: https://github.com/linuxfoundation/lfx-self-serve/tree/main/.claude/skills/lfx-self-serve-pr-readiness
Command: npx skills add https://github.com/linuxfoundation/lfx-self-serve --skill lfx-self-serve-pr-readiness-linuxfoundation

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve? Before opening a pull request, contributors often miss repository hygiene requirements such as branch naming conventions, GitHub Issue references, conventional-commit formatting, rebase status, DCO sign-off, and GPG signing. This Skill audits local commits against the target base branch and reports whether the branch is shaped correctly to open as a PR, without mutating git state. ## Core Features & Use Cases - PR-shape audit: Checks branch name format, ticket references, conventional-commit subjects, rebase status, diff size, DCO + GPG signing per commit, and protected files touched. - Structured verdict report: Emits a severity-tagged findings table with a final verdict of NOT READY, READY WITH CHANGES, or READY. - Checklist-driven findings: Every finding traces back to an item in the references/pr-shape.md checklist, preventing hallucinated results. - Use Case: After finishing a feature branch with signed commits, run this check against origin/main to confirm the branch name, issue reference, commit format, and signing all pass before opening the PR. ## Quick Start Run the PR readiness check on my current branch against origin/main and tell me if it is ready to open as a pull request.

Frequently Asked Questions about lfx-self-serve-pr-readiness

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

FAQPage Schema
How do I check if my branch is ready to open a pull request?▼

Run this check against your base branch, defaulting to origin/main. It audits branch name, issue references, conventional-commit format, rebase status, DCO and GPG signing, diff size, and protected files, then returns a READY, READY WITH CHANGES, or NOT READY verdict.

What commit message format does conventional-commit validation require?▼

Each commit subject must match a type from feat, fix, docs, style, refactor, perf, test, build, ci, or revert, with an optional scope in parentheses, lowercase, and a header of 72 characters or fewer. The chore type is not accepted.

Does this check modify my git history or create the PR?▼

No. The audit is read-only: it runs git log, diff, and merge-base commands and produces a report. It performs no git mutations and has no PR side-effects; fixes like rebasing or amending are left to you.

Why does my commit fail the DCO or GPG signing check?▼

Every commit needs a Signed-off-by trailer in its body and a GPG signature status of G or U. Commits with no signature, a bad signature, or an unverifiable one fail; fix them with git commit --amend --signoff -S or an interactive rebase.

What are protected files and why do they trigger a warning?▼

Protected files are core infrastructure paths defined in the guard-protected-files.sh hook. Touching them produces a SHOULD_FIX finding asking you to surface the changes in the PR description and tag a code owner for explicit review.