DEV Community

Cover image for How do you present a PR?
Luca Scala
Luca Scala

Posted on


How do you present a PR?

So your changes works as expected, it seems that the user story it's really close to the end. Tests are passing, UI looks stunning. It's time to publish a PR for these changes...

Describing a PR in terms of code-changes and user flow can be tricky. What I found in my experience is that,

  • a good description works better that a short list of changes.
  • commenting key-decisions before someone will raise a question works better that arranging meetings to discuss.
  • presenting a GIF of the entire user flow shows that it's working (at least in your setup!) and describe the expected behavior.

Of course this is not needed for tiny PRs.
And you, what's your approach about that?

Photo by Charles Deluvio on Unsplash

Top comments (0)