Skip to content

Add a PR template with risk tiers and revert steps - #93

Closed
erikzrekz wants to merge 1 commit into
mainfrom
claude/pr-template
Closed

erikzrekz wants to merge 1 commit into
mainfrom
claude/pr-template

Conversation

@erikzrekz

Copy link
Copy Markdown
Contributor

What and why

Adds .github/pull_request_template.md, the repo's first PR template, and a one-line rule in AGENTS.md that points agents to it. Most PRs here are written by agents. The template makes each PR state its risk, its blast radius and its revert plan, and it ties a risk tier to the number of author/reviewer cycles the PR needs before someone merges it.

Risk tier

  • T1 Contained: dev tooling. Needs 1 clean cycle and 1 human approval.

Blast radius

  • .github/workflows, scripts/, root config: every contributor sees the template when they open a PR. CI, release and packages are unchanged.

Breaking for any of the above? No.

Risk

  • The tier definitions might not fit how the team actually works. For example, "2 clean cycles" for T2 could be too strict or too loose. These are starting values to tune.
  • A long template can get skimmed. To limit that, the guidance lives in HTML comments that don't render, so the rendered PR shows only the headings and checklists.
  • The T3 rules (a /security-review run, no auto-merge) are written down but no check enforces them yet.

How to revert

  • Before release: git revert -m 1 <merge sha>. Nothing ships to npm, the plugin or the docs, so no other steps are needed.

Verification

git diff --stat main: 2 files, 124 insertions (template + 1 AGENTS.md line)

Not verified: The template doesn't change code, so no build or test commands apply. I haven't checked how GitHub renders it. This PR's own description follows the template.

Repo rules

  • No test, eval or example in this PR spends from a funded wallet, and no secret appears in code, logs or this description

Review notes

  • The tier boundaries in the "Risk tier" section are the part most worth challenging, especially the list of what counts as T3 (the payment path, keys, release.yml, workflow permissions).
  • The "How to revert" guidance covers what can't simply be reverted: published npm versions (fix forward plus npm deprecate), plugin versions (bump again) and docs (redeploy, or deploy from docs-live).

Authorship

Agent (Claude Code), from a request by Eriks. Cycle 0: no review yet.


Generated by Claude Code

The template asks for a risk tier that sets how many author/reviewer
cycles a PR needs, the blast radius across the SDK, CLI, docs and plugin,
and exact revert steps for each surface, including the parts that cannot
be reverted (published npm versions, plugin version numbers).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0168UCoErgQJFUK1dNZknzde
@github-actions

Copy link
Copy Markdown
Contributor

⚠️ No Changeset found

Latest commit: b31cfe9

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@erikzrekz erikzrekz closed this Oct 28, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants