Code Review

Code Reviews help ensure our Update Sets are properly set and that all of the required documentation (Stories etc) are in place before we promote things into Test and Prod. At a high level we will examine each of the following:

1. Ensure the Update Set has a proper Name and Description
2. Ensure the update set has no extraneous updates from other development work
3. Ensure the work done matches what was requested
4. Ensure there is a proper Story (or other ticket) for this work
5. Ensure proper testing was done and documented
6. Ensure nothing dangerous or platform impacting is being requested or performed

Review Name and Description

As laid out in our Update Set page, all Update Sets must have a Name and Description that accurately captures what is being done and the Story/Ticket number related to this work.

Info

When writing these descriptions, write them in such a way that future you (or other developers) will understand what was done and why....A year later. You must remember that while something makes sense to you today....you may forget all about it in a year. Also, it may not be you who is modifying things next, but another developer, so it's important they understand what was done and why.

No Extraneous Updates

As many of us are working on more than one thing at a time, it is all too easy to pick up your work on Story A while having the update set for Story B active. During this part of the process we just help to make sure all of the updates included are related to the Story being requested.

Proper Story

All work being developed in ServiceNow must have a Story attached to it. This Story helps us record Who requested the work be done, Who did the work itself, What was done and How.

The Story must also list out the requirements and Acceptance Criteria.

Ensure Proper Testing

Stories should document any testing done along with the records associated with it. For example: "Tested via INC000123 in Dev".

Ensure Nothing Dangerous

Part of the review process is to ensure that nothing being requested or developed will violate Best Practices or risk causing serious impact to our ServiceNow instances.

For example, the creation of a new Catalog Item or Record Producer is a low impact and low risk change that doesn't warrant any real review, other than making sure the work was tested and the person who requested it is satisfied.

However, work being done that alters core tables (Such as the Incident, Changes, Projects etc) could have an adverse impact and warrant additional scrutiny to ensure we are not negatively impacting other users of the platform.