Skip to content

ci: 👷 Require evidence and book updates in pull requests - #234

Merged
ShisatoYano merged 1 commit into
mainfrom
docs/pr-evidence
Nov 15, 2026
Merged

ShisatoYano merged 1 commit into
mainfrom
docs/pr-evidence

Conversation

@ShisatoYano

Copy link
Copy Markdown
Owner

Summary

Makes every PR show how the change was checked, and makes code changes update the book pages that describe them (#131, "Keeping the book in step").

  • New PR_Evidence workflow: fails while "How I checked it works" is empty, or while a PR with new or changed code under src/ has no images. Editing the description runs it again. PRs opened before the PR template (2026-11-14) are skipped, and the no images needed label lets a change with nothing to show (for example a docstring only) pass
  • It runs on pull_request_target, so first-time contributors see the result without waiting for workflow approval. It only reads the PR description and the list of changed files, never checks out or runs the PR's code, and has read-only permissions
  • PR template: "How I checked it works" and "Images" are required, with what to paste for new code and for changes to existing code (bug fixes, improvements, refactoring), and a new "Book" checkbox
  • HOWTOCONTRIBUTE.md Step 4, and the pr-review skill and checklist, say the same

How I checked it works

Images

Not needed: no code under src/ changes.

Book

  • This PR doesn't change code that the book describes, or I updated those pages

🤖 Generated with Claude Code

Reviews kept finding PRs without a way to see that the change works,
and the rule of #131 that code changes update the book pages had no
check. The PR_Evidence workflow fails while "How I checked it works"
is empty, or while a change to code under src/ has no images, so the
contributor sees it right after opening the PR instead of after a review.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@ShisatoYano ShisatoYano added the enhancement New feature or request label Nov 15, 2026
@ShisatoYano ShisatoYano self-assigned this Nov 15, 2026
@ShisatoYano ShisatoYano moved this from Todo to In Progress in AVCBG Work Plan Nov 15, 2026
@ShisatoYano
ShisatoYano merged commit d1a8183 into main Nov 15, 2026
3 checks passed
@ShisatoYano
ShisatoYano deleted the docs/pr-evidence branch November 15, 2026 22:19
@github-project-automation github-project-automation Bot moved this from In Progress to Done in AVCBG Work Plan Nov 15, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

1 participant