From 42e96743568ad50f34f8a58df7b279af51ec44f3 Mon Sep 17 00:00:00 2001 From: Theo Browne Date: Sun, 8 Mar 2026 17:41:03 -0700 Subject: [PATCH 1/2] 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 --- .github/pull_request_template.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 .github/pull_request_template.md diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 00000000000..8b0c2224aef --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,30 @@ +## Before You Open This PR + +We are not actively accepting contributions right now. + +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. + +Small, focused PRs are strongly preferred. Bug fixes are most likely to be merged. New features will most likely just annoy us. + +If you file a 1,000+ line PR with a bunch of new features, we will probably ban you from the repo going forward. + +## What Changed + +Describe the change clearly and keep scope tight. + +## Why This Change + +Explain the problem being solved and why this approach is the right one. + +## UI Changes + +If this PR changes anything resembling UI, include clear before/after images. + +If the change involves motion, transitions, or other behavior that is difficult to evaluate from screenshots alone, include a short video. + +## Checklist + +- [ ] This PR is small and focused. +- [ ] I explained what changed and why. +- [ ] I included clear before/after images for UI changes. +- [ ] I included a video for animation or interaction changes that need motion to evaluate. From 24c2ec5c175e55c8eb47876baf804b2a490cb641 Mon Sep 17 00:00:00 2001 From: Theo Browne Date: Sun, 8 Mar 2026 18:19:06 -0700 Subject: [PATCH 2/2] 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 first --- CONTRIBUTING.md | 61 +++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 4 ++++ 2 files changed, 65 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000000..fb1992fe739 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,61 @@ +# Contributing + +## Read This First + +We are not actively accepting contributions right now. + +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. + +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. + +## What We Are Most Likely To Accept + +Small, focused bug fixes. + +Small reliability fixes. + +Small performance improvements. + +Tightly scoped maintenance work that clearly improves the project without changing its direction. + +## What We Are Least Likely To Accept + +Large PRs. + +Drive-by feature work. + +Opinionated rewrites. + +Anything that expands product scope without us asking for it first. + +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. + +## If You Still Want To Open A PR + +Keep it small. + +Explain exactly what changed. + +Explain exactly why the change should exist. + +Do not mix unrelated fixes together. + +If the PR makes anything resembling a UI change, include clear before/after images. + +If the change depends on motion, timing, transitions, or interaction details, include a short video. + +If we have to guess what changed, we are much less likely to review it. + +## Issues First + +If you are thinking about a non-trivial change, open an issue first. + +That still does not mean we will want the PR, but it gives you a chance to avoid wasting your time. + +## Be Realistic + +Opening a PR does not create an obligation on our side. + +We may close it. We may ignore it. We may ask you to shrink it. We may reimplement the idea ourselves later. + +If you are fine with that, proceed. diff --git a/README.md b/README.md index 1e37fb78192..03e81b5fb9e 100644 --- a/README.md +++ b/README.md @@ -21,4 +21,8 @@ We are very very early in this project. Expect bugs. We are not accepting contributions yet. +## If you REALLY want to contribute still.... read this first + +Read [CONTRIBUTING.md](./CONTRIBUTING.md) before opening an issue or PR. + Need support? Join the [Discord](https://discord.gg/jn4EGJjrvv).