Code Reviews

To ensure high quality software changes, it is essential that we incorporate peer reviews into the process. The preferred method is to prepare the changes and present them as a “diff” in PDF format, using appropriate tools to clearly show the affected part of the old and new versions. The PDF should be attached to the relevant Jira ticket and the PLC programming group should be invited to review and comment on it.

For significant changes or systems which are not changed often, the code review should also include a meeting to go over and discuss the changes. Attendees should include the EE group members who are involved with PLC programming, stakeholders who are affected by the changes, and other PLC programmers (typically FMS) as optional. In some cases tools may not exist to show a clear difference between the old and new programs, in which case the changes should be carefully explained in the meeting.

The test plan for the changes should also be covered in the meeting, as described in Code Testing.