devguide icon indicating copy to clipboard operation
devguide copied to clipboard

Improve the "Making Good PRs" section

Open erlend-aasland opened this issue 3 years ago • 13 comments

I often see PRs with misleading or vague titles. This is problematic, as the PR titles often end up being the commit titles, and commit titles are one of the most important tools we have when searching for historic changes. Bad titles impact maintainability.

Suggested edits:

  • Enforce a strict title format
  • Promote writing accurate and concise PR titles/descriptions

Perhaps the "Making Good PRs" section can be further promoted. Would it make sense to extract it and move it a level up in the doc hierarchy?

erlend-aasland avatar Aug 08 '22 10:08 erlend-aasland

As a budding open-source contributor and extremely excited to start contributing to my favorite language, I agree with your suggestion, especially for new devs eager to contribute. For example, when creating my first PR, I had to go through the previous closed PRs to gauge the format and structure of the title, branch name, and commit message itself. A format for PRs won't hurt the dev workflow.

abdnafees avatar Nov 19 '22 09:11 abdnafees