Pull request, shortly "PR", is now widely used in software development. Concept is understood, accepted, leveraged by everyone in the area, even by non tech people. During daily standup meetings, it is common to hear a developer saying to have created a PR to a project manager.
Now, as everything, even widely used, it does not imply a good usage. The real beauty of PR is to capture a software change. This capture should be self explanatory. No other special considerations than reading the content of the PR.
The content of the PR is key here. It all starts with the summary, but where it usually ends badly as well unfortunately. Too often, summary is not taken seriously. A big text, with lots of links or checklists, is not important. Better a nicely written text that readers would enjoy checking and would have appetite knowing more.
The writing continues with the code differences. Every highlighted piece is a follow up to let readers keep enjoying the story. A true conversation all the way down from writers to readers, like a book.
Now, all of this takes time, experience to have it right. The journey is worth it. Software development is a true Software craftsmanship. PRs are part of this journey.
Now, as everything, even widely used, it does not imply a good usage. The real beauty of PR is to capture a software change. This capture should be self explanatory. No other special considerations than reading the content of the PR.
The content of the PR is key here. It all starts with the summary, but where it usually ends badly as well unfortunately. Too often, summary is not taken seriously. A big text, with lots of links or checklists, is not important. Better a nicely written text that readers would enjoy checking and would have appetite knowing more.
The writing continues with the code differences. Every highlighted piece is a follow up to let readers keep enjoying the story. A true conversation all the way down from writers to readers, like a book.
Now, all of this takes time, experience to have it right. The journey is worth it. Software development is a true Software craftsmanship. PRs are part of this journey.