Skip to content

Code Review Guidelines

In the KaaS Team, we distinguish between 4 types of Technical 'code' Reviews.

All Code Review 'reports' are captured in description field and comments on Pull Requests.

The checklists are added to the pull requests by cloning the templates in the repo here: Pull-request-templates

Multiple templates can be used in the same Pull Request, but there is a limitation of 4000 characters, so guiding text in the template needs to be removed.

Pipeline Code Review Checklist

When there is a change to the core functional logic, parameters or structure of the pipeline and its resources.

Pipeline Code Review Checklist

Pipeline Code Reviews must be done by peer Codebase SME and/or Platform Architect.

Pipeline Configuration Review Checklist

When input parameters for pipelines are changed, e.g. adding users/roles/permissions and/or scaling existing resources.

Pipeline Configuration Review Checklist

Pipeline Configuration Input Reviews must be done by a peer ADO Operator, Codebase SME and/or Platform Architect.

GitHub Action Code Review Checklist

When there is a significant and/or critical change to the functionality of the Action, e.g. new types of resources or custom methods.

GitHub Action Code Review Checklist

GitHub Action Pipeline Code Reviews are done by a Codebase SME and/or Platform Architect.

GitHub Action Configuration Review Checklist

When input parameters for GIThub Action are changed

GitHub Action Configuration Review Checklist

GitHub Action Configuration Reviews are done by a Codebase SME and/or Platform Architect.

Map Application Review

When a MuleSoft application supporting the platform operations needs to be released/changed, e.g. Pilot applications for test purposes or management application for logging, monitoring etc.

KaaS Team will utilize MAP Code Review templates, created by MAP Platform Team.

MAP Application Review must be done by MAP experienced member.