A place to cache linked articles (think custom and personal wayback machine)
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

12345678910111213141516171819202122232425
  1. title: Pull request templates make code review easier
  2. url: https://quickleft.com/blog/pull-request-templates-make-code-review-easier/
  3. hash_url: e9b8e370e7a0b08985827431c82f1d85
  4. <p>We do a bunch of code reviews at <a href="https://sprint.ly">Sprint.ly</a>. One of the things we&#39;ve done to make that process a little easier is institute a code review template. This template is a free-form list of questions that every person filling out a pull request uses.</p>
  5. <p>Our pull request template looks like this:</p>
  6. <pre><code class="md">#### What&#39;s this PR do?
  7. #### Where should the reviewer start?
  8. #### How should this be manually tested?
  9. #### Any background context you want to provide?
  10. #### What are the relevant tickets?
  11. #### Screenshots (if appropriate)
  12. #### Questions:
  13. - Is there a blog post?
  14. - Does the knowledge base need an update?
  15. - Does this add new (Python) dependencies which need to be added to chef?
  16. </code></pre>
  17. <p>Some sections get a &quot;n/a&quot;, such as the screenshot section for API only changes. In general though, this has proven to make reviewing a much easier process. Curious what it looks like in practice? Here&#39;s an example from a recent pull request. </p>
  18. <p><img src="https://quickleft.com/wp-content/uploads/asset10.png" alt="A pull request template in action"></p>
  19. <p>From just reading this, the reviewer is sufficiently caught up on what this change is, why it is important and how they should tackle this. Just a little of the author&#39;s time can save much more for the reviewer who often lacks context. </p>
  20. <p>Do you have any techniques which makes your code review process smoother? Let us know!</p>