DEV Community

Discussion on: Why you should put effort into your Pull Request description

Collapse
 
offline profile image
Offline

Another tip is to add an ‘How to test’ section that contains the steps to make the functional review easier.

Collapse
 
jwwnz profile image
James Won

Love this! In our team we have a PR template which includes a PR checklist with things to test for.

For example the codebase I primarily work on at the moment is the front-end codebase so we have items like:

[ ] Visual Regressions checked by design
[ ] Unit tests added
[ ] Check acceptance criteria in ticket
Enter fullscreen mode Exit fullscreen mode

But a more detailed 'how to test' section can be even more helpful. In a previous team we had a list of around 10 items (some optional), which was really helpful when understanding when a PR was ready to finalise.