docs: add pull request template - #247
Open
barryroodt wants to merge 3 commits into
Open
Conversation
Add a local PR template on top of the inherited supabase/.github default, adding How to Review and Verification sections tailored to the eval contribution flow (PROMPT.md / EVAL.ts / seed data, and refreshing results in CI).
|
The latest updates on your projects. Learn more about Vercel for GitHub. 1 Skipped Deployment
|
Make the visible How to Review body and review questions generic so experiment, framework, and docs PRs aren't forced into an eval-only shape. Keep the PROMPT.md/EVAL.ts/seed-data path and eval checks as optional guidance, and make the local sanity check plus refreshed CI results a visible verification requirement for eval changes per CONTRIBUTING.md.
A relative ../CONTRIBUTING.md resolves from the PR page once GitHub copies the template into a PR body, so link the repo path instead.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Adds a local pull request template at
.github/PULL_REQUEST_TEMPLATE.md, built on the inheritedsupabase/.githubtemplate.All four existing prompts stay in place, with two additions:
## How to Review: a generic numbered reading path plus review questions, so experiment, framework, and docs PRs aren't forced into an eval-only shape.## Verification: a visible checklist for eval changes covering the local sanity check and refreshed CI results, perCONTRIBUTING.md.Eval-specific guidance (the
PROMPT.md->EVAL.ts-> seed-data path and the motivation/scorer/benchmark/coverage checks) sits in HTML comments as optional prompts, so it stays hidden in posted PRs and applies only when relevant.Why
The inherited org template covers general changes, but eval contributions have a repo-specific review flow. Reviewers should be able to confirm the motivation is cited, scorers deterministically check the end state, benchmark scenarios show legitimate agent failures, and coverage is representative rather than niche. Authors should also see the CI refresh requirement up front.
This mirrors supabase/mcp#385, adapted to the evals workflow.
How to Review
.github/PULL_REQUEST_TEMPLATE.md.## Verificationmakes the local sanity check and refreshed CI results a visible requirement for eval changes.Verification
The net diff against
origin/mainis one new file,.github/PULL_REQUEST_TEMPLATE.md(+61 lines). This is a docs-only addition with no runtime behavior change.