Writing a Pull Request

  • Include the purpose of this Pull Request. For example: "This makes login/register windows close when clicking outside the box".

  • If the change is visual, make sure to include a screenshot or gif

  • Consider providing an overview of why the work is taking place (with any relevant links); don’t assume familiarity with the history.

  • Be explicit about what feedback you want, if any: a quick pair of :eyes: on the code, discussion on the technical approach, critique on design, a review of copy.

  • 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.

  • @mention individuals that you specifically want to involve in the discussion, and mention why.

Last updated