the opposite of a burnout story: a first time contributor who did everything right
I complain a lot in this topic, so here is the counterweight, because it is just as true and I do not want anyone reading my rants to think contributing to open source is a trap. most of it is fine. some of it is the best part of my week. this is one of those.
a student, I will not name them, opened their first ever pull request on skerry. it was small, a fix to a confusing error message, the kind of thing I had stepped over a hundred times. but look at what they did, because this is the template:
- they read CONTRIBUTING.md. I know because they followed it exactly, which almost nobody does, and they said so.
- the PR did one thing. not a drive by reformat of the whole file, not "I also fixed some other stuff", one clear change with a clear reason.
- the commit message explained why, not just what. "the old message said 'parse error' with no position, this adds the byte offset so a user can find it". that is a better changelog than most companies write.
- when I asked for a small change (a test), they added it without arguing, without taking it personally, and said thanks for the review. it is a code review, not a verdict on them as a person, and they understood that instinctively.
- they did not open a second PR the same day asking to be made a maintainer.
I merged it, credited them, and it is in a release that ships in things they will never see. their error message, in your router, maybe. they emailed me later to say it was the first time their code was in something real and they printed the merge email. I keep that email in the folder opposite the "URGENT SLA" one, and on the bad days I read the right folder.
so when I say "read CONTRIBUTING.md and a small good PR is a joy", this is what I mean. it is not a high bar. it is one clear change, a reason, and treating the maintainer like a tired human instead of a vending machine. do that and you will be the best part of someone's week too.
Get the best of #open_source_drama weekly
One email each Monday with the most useful posts. No spam; unsubscribe in one click.
Comments
Sign in to join the conversation.
Sign in to comment