Repository navigation
Pull requests (pr)
Published from
docs/extensions/pr.mdat835522e. Edit the source in the repository, not this page.
Purpose: write a feature changelog and a plain-English explanation with diagrams, then create or update the branch's pull request. It also processes review feedback through an approval step.
| Lifecycle phase | After implement; after review |
| Hooks | One optional after_implement hook (hooks) |
| Commands |
generate, review-feedback (reference) |
| Requires | Illustrate 2.x, enforced by deps.py ensure; Python 3.11 or later; uses Assure and User Manual when installed |
| Standalone | Yes |
| License | MIT |
specify extension add illustrate
specify extension add prGit and a signed-in gh are needed to push and to open the pull request.
/speckit-pr-generate --feature specs/412-refund-approval Update the existing PR with behavior, verified checks and readable diagrams.
/speckit-pr-review-feedback example-org/booking-app#438 Classify unresolved feedback and present the fix and reply plan for approval.
Generate writes docs/<feature-slug>/CHANGELOG.md, a feature explanation and diagrams, then updates a
marked section of the PR description. Add --no-pr to write the documents only. Two scripts do the
fixed parts: pr_changelog.py seeds the changelog from tasks, commits, progress and evidence, and
pr_publish.py writes the exact body, lints its closing references, publishes it with gh and
prints the receipt fields Workflow checks.
Before it touches the PR, Generate checks QA and manual freshness for the extensions you installed. Review Feedback shows a plan and waits for your approval before it edits, replies, commits, pushes or resolves threads. It posts replies and resolves threads only from the approved plan file, and resolves none until the PR head contains the pushed fixes. In the managed Workflow, Finalize runs Generate. Editable source.
- Without
git,gh, authentication or a remote, Generate still writes the documents and reports why it skipped the PR. - Image checks record how they were done:
apion every host,browserwhen the host has a browser tool. - In the managed Workflow, the guard hook refuses a
gh prpublish whose body has no matching lint file, andgh pr createfrom the default branch. - The old
pr-reviewextension is retired. Usereview-feedback.
Package details: PR README.
Published from samykabu/sanduq at 835522e. The pages live in the repository's docs/ folder; edit them there. MIT licensed.
Start
Choose how much to use
Managed delivery
Checks and pull requests
Documentation
Tracking and context
Reference