Update Sets Should Contain A Description

< 1 min read

Impact Area

Scalability

Severity

Warning

Affected Element

Update Sets

Rule number #

SN-0370

Impact #

An empty description field on an Update Set means that the code elements included in it need to be inspected in order to understand the purpose of the changes.

This rule applies to update sets that are “In progress”, not the closed ones. 

Remediation #

Use the description field to clearly and succinctly document the purpose of the Update Set.

Time to fix #

15 min

Updated on March 21, 2025
Was it helpful ?