Skip to content

docs(contributing): set PR expectations and require UI screenshots #3140

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
wpfleger96 merged 1 commit into from
Jul 27, 2026
Merged

docs(contributing): set PR expectations and require UI screenshots #3140

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@
<!-- Fixes #1234, or N/A. Before opening: search existing issues/PRs for duplicates — link the closest one, or say "none found". -->

### Testing
<!-- How was this verified? -->
<!-- How was this verified? UI change? Include before/after screenshots (or a short recording). -->
31 changes: 28 additions & 3 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -284,9 +284,34 @@ required. The scope (in parentheses) is optional but encouraged.
- How to test it manually (if applicable)
- Any follow-up work deferred to a future PR

### Review Process

- We prioritize focused PRs that follow this guide and review as capacity allows.
6. **Shows the UI** — any PR that changes the desktop or mobile UI includes
before/after screenshots (or a short recording for interactions) in the
description. We can't run every branch locally — screenshots let us review
UI changes same-day instead of waiting for someone to build your branch.

### PRs We're Unlikely to Merge

Some kinds of PRs usually get closed — not because they're bad ideas, but
because we can't safely review them without prior discussion:

- **Large refactors or dependency swaps** without a prior issue agreeing on
the direction
- **Cosmetic renames or style-only churn** that doesn't fix a bug or improve
clarity
- **Entirely new features** with no prior discussion
- **Drive-by changes bundled into an unrelated fix** — split them out

If you're considering any of these, open an issue first and we'll tell you
quickly whether it's a direction we'd merge. That saves your time as much as
ours.

### What to Expect After You Open a PR

- Maintainers triage new PRs on a best-effort cadence. Focused PRs that
follow this guide move fastest.
- Duplicates and PRs that skip this guide may be closed with a pointer here
rather than a full review. A close isn't a rejection of you or the idea —
address the gaps and reopen (or open a fresh PR) anytime.
- Address review comments by pushing new commits (don't force-push during
review; it makes it hard to see what changed).
- Once approved, a maintainer will squash-merge your PR.
Expand Down
Loading