Code Review Results¶
Code Review Results are stored as Pull Requests in Azure DevOps. They include the Source and Target Branches of the Pull Request, all git commits or code changes, Title, description, discussion threads, work item links, required and optional reviewers, and tags. The Pull Request Description can be templated to include a common code review checklist or populated with commit titles and can’t be edited once the pull request is complete. Azure DevOps helps reviewers by displaying the files being changed, tracking updates or new commits, all commits, conflicts, and discussion threads. Tags are added to the pull request to help categorize the issues addressed during the code review, teams can define additional categories but the default tags are in the Pull Request Tag Categories table.
Pull Request Issue Category | Tag Name | Category Description |
---|---|---|
Automated Test | Test | Need new or updated automated tests; Automated test failures; Failure to meet code coverage standards |
Code Defect | Bug | Code would create a bug unless addressed; Bug issues in the code were identified by a code scanning tool |
Security Defect | Security | Code would create a security vulnerability unless addressed; Code violates security standards; Security issues in the code were identified by a code scanning tool |
High Complexity | Complexity | Code is overly complex; Code doesn’t utilize new language patterns that would simplify it; increase in complexity identified by a code scanning tool |
Team Standards | Standards | Failure to meet code coding standards; Failure to meet code style / formatting standards; increase in code smells identified by a code scanning tool |
Irrelevant Code | Irrelevant | Code changes not related to the linked User Story or bug were included; Multiple unrelated User Stories or Bugs were included in the same pull request; unintended code changes were added or added to the wrong branch |
Convoluted Review | Convoluted | Multiple Commits were added while the Pull Request was active; Difficulties encountered while reviewing the code do to additional code changes; Code changes were complicated and difficult to follow; Code needed additional discussion threads to be understood |
Unreachable Code | Unreachable | Identified unreachable, dead, or redundant code needing removal; files that are no longer used and should be deleted; superfluous commented out code |
Solution Architecture | Architecture | Updates needed to comply with Solution Architecture |
User Story | Requirements | Updates needed to meet the User Story Acceptance Criteria; Changes to the User Story needed to match the completed functionality |
Poor Performance | Performance | Failure to meet performance standards |
USED IN¶
See Also¶
Process Guidance Version: 10.4