High Quality Contribution #1049
Replies: 1 comment
-
|
Good question, and the honest answer is that "high quality" has very little to do with how clever the code is. After reviewing a lot of PRs, the ones that stand out almost always share the same handful of traits. It's scoped to one concern. The change does exactly one thing. No drive by refactor bundled in, no formatting churn touching 40 unrelated files. A tight diff that reads top to bottom is something I can review in one sitting and merge with confidence. A 2,000 line PR that does "a few things" is one I'll keep putting off. Prove that the change actually works. A test that fails without your patch and passes with it is the single strongest signal you can send. It's the difference between "I think this works" and proof that it does, and it protects your change from getting broken by the next person six months from now. Your commit needs to explains the why, not just the what. The diff already shows what changed. What I can't see is why. A clear PR description and commit message carry that context, because the git blame is the only thing the next maintainer gets. "Fixed bug" tells me nothing; a sentence on the root cause tells me everything. Respect the project's existing conventions. Matching the repo's patterns, lint config, and naming instead of importing your own style lowers the maintenance cost for everyone who touches that file after you. Consistency is a feature!! The author actually engages. The fastest way to lose me is opening a PR and going silent when review comments come in. The contributors I remember are the ones who responded to feedback, iterated, and saw it through. That signals you understand the code you wrote, which honestly matters more now than it used to. If I had to compress it to one line: a high quality contribution is one that lowers my workload instead of shifting it onto me. Everything above is just different angles on that same idea. Hope that helps! |
Beta Was this translation helpful? Give feedback.
Uh oh!
There was an error while loading. Please reload this page.
-
From a maintainer’s perspective, what makes a contribution “high quality”?
Beta Was this translation helpful? Give feedback.
All reactions