| author |  Theo Browne <me@t3.gg> 2026-03-08 18:20:05-07:00 |
| committer |  GitHub <noreply@github.com> 2026-03-08 18:20:05-07:00 |
| log | 5815ba24e2478b2801fab98163e72dd476e5c280 |
| tree | 5cef50ccc9ca47873ff802b649503264882c5cf1 |
| parent | 5de8e9d1ae5dfae3e7ea2bb64c9ecd1420d63821 |
| signature | Signed by PGP key B5690EEEBB952194 |
Add pull request template with contribution notice and review checklist (#582)
* Add PR template with contribution notice and review checklist
- Add `.github/pull_request_template.md`
- Set expectations that external PRs may not be reviewed or merged
- Require clear change rationale plus UI before/after media when applicable
* Add contribution policy notice and link detailed guidelines
- add CONTRIBUTING.md with clear expectations for external PRs
- update README to direct would-be contributors to CONTRIBUTING.md first3 files changed, 95 insertions(+), 0 deletions(-)
.github/pull_request_template.md created+30
| ... | @@ -0,0 +1,30 @@ | ||
| 1 | ## Before You Open This PR | ||
| 2 | |||
| 3 | We are not actively accepting contributions right now. | ||
| 4 | |||
| 5 | You can still open a PR, but please do so knowing there is a high chance we may close it without merging it, or never review it. | ||
| 6 | |||
| 7 | Small, focused PRs are strongly preferred. Bug fixes are most likely to be merged. New features will most likely just annoy us. | ||
| 8 | |||
| 9 | If you file a 1,000+ line PR with a bunch of new features, we will probably ban you from the repo going forward. | ||
| 10 | |||
| 11 | ## What Changed | ||
| 12 | |||
| 13 | Describe the change clearly and keep scope tight. | ||
| 14 | |||
| 15 | ## Why This Change | ||
| 16 | |||
| 17 | Explain the problem being solved and why this approach is the right one. | ||
| 18 | |||
| 19 | ## UI Changes | ||
| 20 | |||
| 21 | If this PR changes anything resembling UI, include clear before/after images. | ||
| 22 | |||
| 23 | If the change involves motion, transitions, or other behavior that is difficult to evaluate from screenshots alone, include a short video. | ||
| 24 | |||
| 25 | ## Checklist | ||
| 26 | |||
| 27 | - [ ] This PR is small and focused. | ||
| 28 | - [ ] I explained what changed and why. | ||
| 29 | - [ ] I included clear before/after images for UI changes. | ||
| 30 | - [ ] I included a video for animation or interaction changes that need motion to evaluate. | ||
CONTRIBUTING.md created+61
| ... | @@ -0,0 +1,61 @@ | ||
| 1 | # Contributing | ||
| 2 | |||
| 3 | ## Read This First | ||
| 4 | |||
| 5 | We are not actively accepting contributions right now. | ||
| 6 | |||
| 7 | You can still open an issue or PR, but please do so knowing there is a high chance we close it, defer it forever, or never look at it. | ||
| 8 | |||
| 9 | If that sounds annoying, that is because it is. This project is still early and we are trying to keep scope, quality, and direction under control. | ||
| 10 | |||
| 11 | ## What We Are Most Likely To Accept | ||
| 12 | |||
| 13 | Small, focused bug fixes. | ||
| 14 | |||
| 15 | Small reliability fixes. | ||
| 16 | |||
| 17 | Small performance improvements. | ||
| 18 | |||
| 19 | Tightly scoped maintenance work that clearly improves the project without changing its direction. | ||
| 20 | |||
| 21 | ## What We Are Least Likely To Accept | ||
| 22 | |||
| 23 | Large PRs. | ||
| 24 | |||
| 25 | Drive-by feature work. | ||
| 26 | |||
| 27 | Opinionated rewrites. | ||
| 28 | |||
| 29 | Anything that expands product scope without us asking for it first. | ||
| 30 | |||
| 31 | If you open a 1,000+ line PR full of new features, we will probably close it quickly and remember that you ignored the clearly written instructions. | ||
| 32 | |||
| 33 | ## If You Still Want To Open A PR | ||
| 34 | |||
| 35 | Keep it small. | ||
| 36 | |||
| 37 | Explain exactly what changed. | ||
| 38 | |||
| 39 | Explain exactly why the change should exist. | ||
| 40 | |||
| 41 | Do not mix unrelated fixes together. | ||
| 42 | |||
| 43 | If the PR makes anything resembling a UI change, include clear before/after images. | ||
| 44 | |||
| 45 | If the change depends on motion, timing, transitions, or interaction details, include a short video. | ||
| 46 | |||
| 47 | If we have to guess what changed, we are much less likely to review it. | ||
| 48 | |||
| 49 | ## Issues First | ||
| 50 | |||
| 51 | If you are thinking about a non-trivial change, open an issue first. | ||
| 52 | |||
| 53 | That still does not mean we will want the PR, but it gives you a chance to avoid wasting your time. | ||
| 54 | |||
| 55 | ## Be Realistic | ||
| 56 | |||
| 57 | Opening a PR does not create an obligation on our side. | ||
| 58 | |||
| 59 | We may close it. We may ignore it. We may ask you to shrink it. We may reimplement the idea ourselves later. | ||
| 60 | |||
| 61 | If you are fine with that, proceed. | ||
README.md+4
| ... | @@ -21,4 +21,8 @@ We are very very early in this project. Expect bugs. | ... | @@ -21,4 +21,8 @@ We are very very early in this project. Expect bugs. |
| 21 | 21 | ||
| 22 | We are not accepting contributions yet. | 22 | We are not accepting contributions yet. |
| 23 | 23 | ||
| 24 | ## If you REALLY want to contribute still.... read this first | ||
| 25 | |||
| 26 | Read [CONTRIBUTING.md](./CONTRIBUTING.md) before opening an issue or PR. | ||
| 27 | |||
| 24 | Need support? Join the [Discord](https://discord.gg/jn4EGJjrvv). | 28 | Need support? Join the [Discord](https://discord.gg/jn4EGJjrvv). |