Dev & Engineering

writing-pr: PR Title & Body Standards

A PR-writing standard that puts the shape of a change on the first screen: Conventional Commits titles, evidence-driven bodies, and a mandatory local-verification section.

58/ 100
Recommended

Generally reliable with disclosed limitations; trial as directed and keep a rollback path.

See how it was scored ↓
Works as-is in
Codex · Claude Code
Stars
★ 8.7k
Last updated
1d ago
License
Apache-2.0
pull-requestcode-reviewconventional-commitsgh-cli
+3technical-writingmermaiddeveloper-workflow

What does this skill do, and when should you use it?

writing-pr is one of 10 internal skills bundled in the tester-army/e2e repository at .dev/skills/writing-pr/SKILL.md, marked `internal: true`. It defines how PRs to that repo are written: Conventional Commits titles that survive squash-merge, bodies built from bullets, mermaid diagrams, code references, and before/after tables, plus a required `## Verified` section documenting local testing. It also lists what to leave out (CI-reported checks, intermediate history, unrequested checklists) and which AI-writing tells to strip via an unslop pass. It is a documentation-style skill tied to the repo's contribution process, with no scripts.

  • Produces Conventional Commits-style PR titles matching the repo's squash-merge convention, including ! for breaking changes
  • Structures PR bodies as bullets + mermaid diagrams for flow/state + fenced code blocks + file:line references and GitHub permalinks
  • Generates before/after tables for visual changes, | main | this branch | bug/fix tables for fixes, and benchmark tables with the target branch as baseline
  • Enforces a ## Verified section whose first line states whether it ran locally and why not when it didn't, with media uploaded via gh 2.99+ --attach
  • Runs an unslop voice check to strip filler like 'This PR introduces...', 'comprehensive', 'ensures'
  • Excludes intermediate refactoring history, line-by-line diff restatement, and unprompted checklists
Good fit
  • A contributor fixing a bug in tester-army/e2e who must show the bug and fix side by side with local verification evidence
  • A developer landing an architectural change to runner phases or engine hooks that needs a mermaid flow diagram and before/after architecture
  • An author of a performance PR who needs a benchmark table with main as the baseline and the PR as candidate
  • A docs-only or CI-only contributor who must honestly declare 'Ran it locally: no' with a reason
  • Anyone whose AI-drafted PR description needs the marketing tone stripped before posting
Not a fit
  • Contributors outside the e2e repo: the rules bind to that repo's squash-merge flow, verify skill, and path conventions, so adopting it elsewhere requires rewriting
  • Users with no way to run or verify changes locally: every PR must carry real verification evidence
  • Anyone wanting generic PR copy generation: this is a strict editorial standard, not a copywriter

How do you install this skill?

Before you use it
  • The skill is repo-internal (internal: true) with conventions specific to this repository (squash-merge, suiteVersion, the verify skill); direct transplant to other repos will not fit.
  • Referenced ../verify/SKILL.md and the unslop skill file are absent from this evidence; confirm those paths exist before use.
  • The recommended gh --attach behavior requires gh 2.99+; verify on older environments.
  • English-only guidance, no Chinese-language support.
  • Static review only; no verification workflow was executed.
Before you start
Your agent needs
  • Shell / CLI
  • Network access
  • Local filesystem
Install first
  • GitHub CLI (gh 2.99+ for media uploads)

The source gives no command to install this skill separately. It is an internal skill inside the tester-army/e2e repo, obtained by cloning:

git clone https://github.com/tester-army/e2e

The README only documents installing the e2e testing framework itself (npx e2e init); it provides no steps for installing the writing-pr skill into Claude Code or other Agent Skills clients, so none are invented here.

How do you use this skill?

Try saying

Once installed, send your agent any of these to trigger it:

  • Draft the PR title and body per writing-pr for this runner prepare hook fix, including a Verified section
  • Rewrite this PR description to drop filler like 'comprehensive' and 'ensures' and use bullets with evidence
  • The change alters the replay flow; draw a mermaid diagram for the PR body
  • I ran the fix locally; organize the bug-vs-fix before/after table and the gh --attach command

The skill triggers when writing or editing a PR title or body (its description states this directly). The flow: title in Conventional Commits form; a short bullet body with evidence (diagrams, code refs, comparison tables); then a ## Verified section. Upload media with:

gh pr edit <pr> --body-file body.md --attach ./main.png --attach ./branch.png --attach ./video.webm

Reference images in the body as ![after](./after.png); gh uploads attachments and rewrites those paths. Do not write video paths in the body: attached videos are appended at the end as players. Run the unslop pass on the final text before posting.

What are this skill's strengths and limitations?

Pros
  • Rules are concrete and actionable, with reusable Markdown templates for Verified, benchmarks, and mermaid diagrams
  • Targeted checklist for AI-writing tells (filler phrases, bold label lists, em dashes, padding bullets to three)
  • Clear boundary between what must be written (Verified evidence) and what to leave out
Limitations
  • Marked internal and deeply tied to the e2e repo's squash-merge flow, verify skill, and path conventions; cross-repo reuse requires rewriting
  • No scripts or automation; everything is prose standards followed manually or by an agent
  • The mandatory Verified section and local-run requirement burden contributors who cannot verify locally

How does this skill compare with similar options?

Side by side with related skills; every score comes from the same FSRS standard.

Skill FS score Stars Last updated License
writing-pr: PR Title & Body Standards this page 58 · Recommended ★ 8.7k 1d ago Apache-2.0
Ship a PR (e2e repo PR delivery workflow) 59 · Recommended ★ 8.7k 1d ago Apache-2.0
CodeRabbit Code Review 57 · Use with care ★ 188 4d ago MIT
RenderCV PR Reviewer 55 · Use with care ★ 18k 6mo ago MIT
Codex Pull Request Editor ✓ OpenAI · Official 50 · Use with care ★ 128k 3d ago Apache-2.0

The source names no competitor, but it references two companion skills in the same repo: verify (local verification) and unslop (voice check); the three work as a set.

How did FollowSkills review this skill?

FollowSkills review · FSRS-2.0
Recommended
58/ 100 5-point scale 2.9 / 5
1Trust20 / 25 · 4.0/5

Pure writing guidance: no command execution, no permission requests, no external side effects or sensitive-data handling; the only external interaction is the gh CLI media-attachment workflow, transparently described. Deducted for unverified publisher attribution and no discussion of the information boundary when pasting content into PRs.

2Reliability13 / 20 · 3.3/5

Instructions are self-consistent and well structured (title/body/Verified/templates), templates are directly reusable, and the gh --attach usage is concrete. Deducted because the referenced ../verify/SKILL.md and unslop skill files are not in the evidence, so path existence is unconfirmed; as prose-only guidance there is no abnormal-input handling to assess.

3Adaptability8 / 15 · 2.7/5

Trigger condition is explicit (when writing or editing a PR title or body), the description matches content, and false-trigger risk is low. Deducted for internal: true scoping with repository-specific conventions (squash-merge, suiteVersion, the verify skill) that do not transfer to other repos; no Chinese-language support; depends on GitHub/gh and image uploads with no declared non-fit boundary.

4Convention9 / 15 · 3.0/5

Well-layered documentation: principles first, details after, with templates, anti-patterns (Leave out, Voice) and frontmatter present. Deducted for the skill file's lack of versioning or changelog, no in-file maintenance ownership, and an out-of-tree unslop reference path (../../../.claude/skills/) absent from the evidence, a hidden assumption.

5Effectiveness5 / 15 · 1.7/5

Concrete, actionable format and content rules for the PR-writing task, offering real marginal value over generic guidance. Deducted because static review cannot confirm outputs are directly usable, and some rules (gh 2.99+ --attach behavior, squash-merge title convention) rest on external facts not reproduced in this evidence.

6Verifiability3 / 10 · 1.5/5

Core claims (gh --attach path rewriting, repo merge conventions) have no independent corroboration within the provided files; other repository material (CI workflows, SECURITY.md) is only weakly related to the skill's own claims. Static-review constraints cap this score.

1 2 3 4 5 6

Open a dimension to read why it scored that way

Reviewed Oct 10, 2026 Reviewed revision 449fa93670ee Review evidence[1][2][3][4][5][6][7][8][9][10]

Evidence confidence:Low — Mostly static review, author material or a limited demo; useful for discovery, not high-risk decisions.

See the full review method →

FAQ

Is this for use outside the e2e repo?
Not primarily. It is marked internal and its rules bind to e2e's squash-merge flow and internal skill references; other repos can borrow the structure but must adapt it.
How do I satisfy the Verified requirement for a docs-only or CI-only PR?
Open with 'Ran it locally: no - <why>'. The source's accepted reasons include docs typos, CI-only changes, and not having the required device.
What tools does it need?
The GitHub CLI, version 2.99 or higher, for --attach media uploads. It also requires running the unslop skill, located in the same repo at .claude/skills/unslop/.
How do videos get into a PR?
Do not write video paths in the body. Pass videos as --attach files; gh appends them at the end of the PR where they render as players.

More skills from this repository

All from tester-army/e2e

Dev & Engineering

Ship a PR (e2e repo PR delivery workflow)

Turn finished work in the tester-army/e2e repo into a PR a human can review without fighting CI or bots: checks, verification, a fresh-context self-review, the PR itself, then babysitting to the Ready for Human Review label.

★ 8.7k FS 59 Recommended 1d ago
Dev & Engineering

babysit — PR Babysitting Skill

Drive an open pull request through conflicts, review bots, and CI until it is fully green with every thread handled, then hand it off labeled Ready for Human Review.

★ 8.7k FS 54 Use with care 1d ago
Writing & Content

e2e Docs Authoring Skill

Applies a skimmer-first writing and shortening standard whenever you write, edit, or restructure guide pages on the e2e docs site.

★ 8.7k FS 54 Use with care 1d ago
Dev & Engineering

e2e Verify — End-to-End Change Verification Skill

Prove every change with the real CLI against the testbed and benchmark apps — visible evidence, not "it compiles".

★ 8.7k FS 64 Recommended 1d ago
Dev & Engineering

unbox-ai — AI Agent Trace Analysis CLI

Analyze AI agent trace files from the CLI without reading megabytes of raw JSON, and find out why an agent run was slow or expensive.

★ 8.7k FS 54 Use with care 1d ago
Writing & Content

Unslop

Edits AI tells out of any text and injects a human voice, so model-drafted writing stops reading like model-drafted writing. Its description says it must always apply.

★ 8.7k FS 49 Use with care 1d ago
Dev & Engineering

e2e Playground Verification Skill

Launch, drive, and prove the apps/testbed playground works — with traces, screenshots, and a bug bash — before you claim a change works.

★ 8.7k FS 59 Recommended 1d ago
Dev & Engineering

Create Verification Skill (for e2e)

Generates a project-local verify-<app> skill so any coding agent can launch your app, drive it like a user, keep evidence, and bug bash it.

★ 8.7k FS 54 Use with care 1d ago
Dev & Engineering

e2e: Agentic End-to-End Testing

Drive browser and mobile UI tests with natural-language agent goals, paired with exact locator assertions and a replay cache that keeps model costs down.

★ 8.7k FS 52 Use with care 1d ago

Related skills