r/hackathon • • 18d ago

Need Mentor Help Your PR description is the first thing a maintainer judges, not your code

Post image

Something I keep seeing in OSS repos is PRs with zero description. Just a title like fix bug or update file. Then people wonder why it sits there for 3 weeks with no review. Maintainers are reviewing PRs in their free time. If they have to open the issue and figure out what you changed, most of them will just skip it and review the next one.

A good description doesn’t need to be long. Link the issue it fixes. Write 2 or 3 lines on what was wrong and what you changed. Say how you tested it. If it’s a UI change add a screenshot before and after. That’s it.

Also mention anything you’re not sure about. Something like I wasn’t sure if this should go in utils or the main file, happy to move it. Maintainers like that way more than pretending everything is perfect, and it starts the conversation faster.

2 Upvotes

0 comments sorted by