DEV Community

Andrey Bodoev for MyCareersFuture

Posted on • Edited on

3

Code Review: Prereview checklist. No important tasks are forgotten.

Here's my rephrase on preflight checklist,

a prereview checklist is a list of tasks that should be performed by developer or team prior to raise an Merge Request 

Everytime we discussing changes in code review, we might found ourself talking about same things over and over again. For example, asking in comments to add testing instructions or adding pivotal story number for reference. 

To prevent that we need a little reminder to ourselves, or list of things we should check before raising an attention to your changes.

In our team we have checklists built-in in our Merge Request templates.

Here an example of one of our templates,

<!-- Make sure Merge Request title following "<type>: <subject> [#<pivotal_story_id>]" -->

<!-- Brief description. Examples are, screenshots, steps to reproduce, links to dependent MRs -->

### General Checklist:

- [ ] Exact versions in package.json
- [ ] Testing instructions?
- [ ] Docs? Examples are, update `README.md` file, or add ADR in `doc/adr`
- [ ] Tests?
- [ ] Put in copy at least two potential reviewers

/cc

/label ~"Review Me"
Enter fullscreen mode Exit fullscreen mode

Structure of this template are self-explanatory, one thing I want to point out is last line: /label ~"Review Me" on which I already wrote an article.

And don't forget to treat checklists as living documentation, new items can be added, or removed throughout time.

It's purpose is to improve code review safety by ensuring that no important tasks are forgotten.

Image of AssemblyAI tool

Challenge Submission: SpeechCraft - AI-Powered Speech Analysis for Better Communication

SpeechCraft is an advanced real-time speech analytics platform that transforms spoken words into actionable insights. Using cutting-edge AI technology from AssemblyAI, it provides instant transcription while analyzing multiple dimensions of speech performance.

Read full post

Top comments (0)

Heroku

This site is built on Heroku

Join the ranks of developers at Salesforce, Airbase, DEV, and more who deploy their mission critical applications on Heroku. Sign up today and launch your first app!

Get Started

👋 Kindness is contagious

Immerse yourself in a wealth of knowledge with this piece, supported by the inclusive DEV Community—every developer, no matter where they are in their journey, is invited to contribute to our collective wisdom.

A simple “thank you” goes a long way—express your gratitude below in the comments!

Gathering insights enriches our journey on DEV and fortifies our community ties. Did you find this article valuable? Taking a moment to thank the author can have a significant impact.

Okay