Skip to content

How to create a good PR

prasanna1211 edited this page Feb 1, 2018 · 1 revision
  1. Consider providing an overview of why the work is taking place.
  2. Remember that anyone in the company could be reading this Pull Request, so the content and tone may inform people other than those taking part, now or later.
  3. Assign Reviewers for a PR who will approve and merge.
  4. Be explicit about when you want feedback, if the Pull Request is work in progress, say so. A prefix of “[WIP]” in the title is a simple, common pattern to indicate that state.
  5. Assign Labels so that it is easy to identify why we are doing this P.R.

@mention individuals that you specifically want to involve in the discussion, and mention why. (“/cc @jesseplusplus for clarification on this logic”)