Repository navigation
chore: add PR description template - #1342
Merged
Merged
Conversation
Adds .github/pull_request_template.md so PR bodies default to a consistent shape (Summary, Why, What changed, Screenshots, Related Resources, Testing) instead of free-form text. Modeled on the dragon/tiger GitLab MR templates, trimmed to drop sections that don't apply here: no Type of Change section (pr-title.yml already enforces the conventional-commit prefix on the title), no pre-submit checklist (covered by CI), no PII/backend-branch-pairing checklist items. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Contributor
|
Deploy preview for adp-cost-calculator ready!
Deployed with vercel-action |
Contributor
|
Deploy preview for remote-flows ready!
Deployed with vercel-action |
Contributor
📊 Coverage Report⚪ Coverage unchanged
Detailed BreakdownLines Coverage
Statements Coverage
Functions Coverage
Branches Coverage
✅ Coverage check passed |
jordividaller
approved these changes
Sep 21, 2026
Merged
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
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.
Summary
Adds a default PR description template so new PRs open with a consistent
shape instead of free-form text.
Why
Diffs show what changed but not why, and that context was getting lost
because nothing prompted for it. Modeled the sections on the GitLab MR
templates used in the dragon/tiger sibling repos, trimmed to what actually
applies to a published npm library rather than a deployed app.
What changed
Toggle details
Added
.github/pull_request_template.mdwith: Summary, Why, What changed(collapsed), Screenshots (collapsed), Related Resources, Testing.
Deliberately left out, compared to the dragon/tiger source templates:
pr-title.ymlalready enforces theconventional-commit
type(scope):prefix on the PR title, so a bodysection would just restate it.
fast enough that a manual checklist is noise.
(Datadog PII redaction, paired backend MR), don't apply to this repo.
Kept a light two-line Testing section (browser test against
example/,feature flag) since this repo does have real feature-flag-gated behavior
(e.g.
CurrencyConversionField, bulk GP activation).Screenshots
N/A — no rendered UI change, this only adds a template file.
Related Resources
N/A
Testing
N/A — template-only change, nothing to run. Verified by opening this PR
itself and confirming the sections above render as intended.
Note
Low Risk
Adds a GitHub markdown template only; no application code, APIs, or CI behavior changes.
Overview
Adds a GitHub pull request template at
.github/pull_request_template.mdso new PRs open with a fixed outline instead of a blank description.The template prompts for Summary, Why, and What changed (in a collapsible block), plus optional Screenshots, Related Resources, and a short Testing checklist (browser check against
example/, feature flag). Inline HTML comments explain what to write in each section and when to use N/A.This is process/documentation only; it does not change library code or runtime behavior.
Reviewed by Cursor Bugbot for commit 4d5ea5e. Bugbot is set up for automated code reviews on this repo. Configure here.