|
| 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. |
0 commit comments