Skip to content

Code Review

ds-mkanal edited this page Jun 6, 2024 · 1 revision

General Guideline

We are following Google's Code Review Developer Guide.  Additional rules are explained below.

Focus topics

  • Functionality
  • Software design
  • Complexity
  • Tests
  • Naming
  • Comments
  • Style
  • Documentation

Additional Rules

|Rule|Reference|Relevance|Comment| | Check Secure Coding standards | IRS Code Standards | High | Check if security coding standards are fulfilled. | | Unit test with focus on logic. | IRS Code Standards | High | Check if the logic / workflow and the feature is covered by tests.  | | Writing methods which provides a response to be better tested. | IRS Code Standards | Medium | Check if security coding standards are fulfilled. | | In case of any change in IRS API Swagger, the version MUST be updated | IRS Code Standards | High | Semantic versioning Major.Minor.Patch(Bugfix) version.  |

Clone this wiki locally