Skip to content

Commit 8cd2fba

Browse files
authored
Create CONTRIBUTING.md
1 parent dca3b6a commit 8cd2fba

1 file changed

Lines changed: 61 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
# Contributing
2+
3+
## Read This First
4+
5+
I'm 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 I 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 me and users trying to keep it scoped, quality, and direction under control.
10+
11+
## What I'm 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 I 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 discussing it in community or asking for it first.
30+
31+
If you open a 1,000+ line PR full of new features, I 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 I have to guess what changed, I 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 I 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+
I may close it. I may ignore it. I may ask you to shrink it. I may reimplement the idea ourselves later.
60+
61+
If you are fine with that, proceed.

0 commit comments

Comments
 (0)