- The implementation fulfills the desired requirement.
Details
The code does the intended while also ensuring that it does not cause side-effects or compromise the system performance and functionality. - The code does not add unnecessary complexity.
Details
The code is neither too simple and long (over-engineering) nor too short and complex for peers. With a complex code, devs are likely to introduce bugs when calling or modifying the code.
In order to integrate the code review checklist into your project as a PR template, follow the below mentioned steps:
- On the main/default branch, create file
pull_request_template.md
inside the.github
folder. - Copy paste the checklist markdown. Commit the file.
- Once the file is pushed on main/default branch, the PR template will reflect in future PRs.