{"id":13726363,"url":"https://github.com/mgreiler/code-review-checklist","last_synced_at":"2025-05-07T21:32:16.399Z","repository":{"id":37999060,"uuid":"292240757","full_name":"mgreiler/code-review-checklist","owner":"mgreiler","description":"This code review checklist helps you be a more effective and efficient code reviewer.","archived":false,"fork":false,"pushed_at":"2024-02-19T08:45:58.000Z","size":43,"stargazers_count":871,"open_issues_count":4,"forks_count":165,"subscribers_count":25,"default_branch":"master","last_synced_at":"2024-08-04T01:28:48.952Z","etag":null,"topics":["checklist","clean-code","code-quality","code-review","code-review-checklist","code-reviews","merge-request","pull-requests","readability"],"latest_commit_sha":null,"homepage":"http://www.awesomecodereviews.com","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mgreiler.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2020-09-02T09:37:06.000Z","updated_at":"2024-08-02T21:16:08.000Z","dependencies_parsed_at":"2023-02-09T21:30:46.192Z","dependency_job_id":"81418a99-6776-43f7-b06d-42119969674a","html_url":"https://github.com/mgreiler/code-review-checklist","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mgreiler%2Fcode-review-checklist","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mgreiler%2Fcode-review-checklist/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mgreiler%2Fcode-review-checklist/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mgreiler%2Fcode-review-checklist/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mgreiler","download_url":"https://codeload.github.com/mgreiler/code-review-checklist/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224654233,"owners_count":17347703,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["checklist","clean-code","code-quality","code-review","code-review-checklist","code-reviews","merge-request","pull-requests","readability"],"created_at":"2024-08-03T01:03:01.317Z","updated_at":"2024-11-14T16:33:44.598Z","avatar_url":"https://github.com/mgreiler.png","language":null,"funding_links":[],"categories":["Others"],"sub_categories":[],"readme":"# Code Review Checklist\n\n## Implementation\n- [ ] Does this code change accomplish what it is supposed to do?\n- [ ] Can this solution be simplified?\n- [ ] Does this change add unwanted compile-time or run-time dependencies?\n- [ ] Is a framework, API, library, or service used that should not be used?\n- [ ] Could an additional framework, API, library, or service improve the solution?\n- [ ] Is the code at the right abstraction level?\n- [ ] Is the code modular enough?\n- [ ] Can a better solution be found in terms of maintainability, readability, performance, or security?\n- [ ] Does similar functionality already exist in the codebase? If yes, why isn’t it reused?\n- [ ] Are there any best practices, design patterns or language-specific patterns that could substantially improve this code? \n- [ ] Does this code adhere to Object-Oriented Analysis and Design Principles, like the Single Responsibility Principle, Open-Close Principle, Liskov Substitution Principle, Interface Segregation, or Dependency Injection?\n\n## Logic Errors and Bugs\n- [ ] Can you think of any use case in which the\ncode does not behave as intended?\n- [ ] Can you think of any inputs or external events\nthat could break the code?\n\n## Error Handling and Logging\n- [ ] Is error handling done the correct way?\n- [ ] Should any logging or debugging information\nbe added or removed?\n- [ ] Are error messages user-friendly?\n- [ ] Are there enough log events and are they\nwritten in a way that allows for easy\ndebugging?\n\n## Dependencies\n- [ ] Were updates to documentation, configuration, or readme files made as required by this change?\n- [ ] Are there any potential impacts on other parts of the system or backward compatibility?\n\n## Security and Data Privacy\n- [ ] Does the code introduce any security vulnerabilities?\n- [ ] Are authorization and authentication handled correctly?\n- [ ] Is (user) input validated, sanitized, and escaped \nto prevent security attacks such as cross-site \nscripting or SQL injection?\n- [ ] Is sensitive data like user data or credit card\ninformation securely handled and stored?\n- [ ] Is the right encryption used?\n- [ ] Does this code change reveal any secret\ninformation like keys, passwords, or usernames?\n- [ ] Is data retrieved from external APIs or libraries\nchecked for security issues?\n\n## Performance\n- [ ] Do you think this code change decreases\nsystem performance?\n- [ ] Do you see any potential to improve the\nperformance of the code significantly?\n\n\n## Usability and Accessibility\n- [ ] Is the proposed solution well-designed from a\nusability perspective?\n- [ ] Is the API well documented?\n- [ ] Is the proposed solution (UI) accessible?\n- [ ] Is the API/UI intuitive to use?\n\n## Ethics and Morality\n- [ ] Does this change make use of user data in a way that \nmight raise privacy concerns?\n- [ ] Does the change exploit behavioral patterns or human\nweaknesses? \n- [ ] Might the code, or what it enables, lead to mental \nand physical harm for (some) users?\n- [ ] If the code adds or alters ways in which people \ninteract with each other, are appropriate measures\nin place to prevent/limit/report harassment or abuse?\n- [ ] Does this change lead to an exclusion of a certain\ngroup of people or users?\n- [ ] Does this code change introduce unjust impact on people, \nparticularly those related to sensitive characteristics such as\nrace, ethnicity, gender, nationality, income, sexual orientation, ability, \nand political or religious belief?\n- [ ] Does this code change introduce any algorithm, \nAI  or machine learning bias?\n\n\n## Testing and Testability\n- [ ] Is the code testable?\n- [ ] Have automated tests been added, or have related ones been updated to cover the change?\n- [ ] Do the existing tests reasonably cover the code change (unit/integration/system tests)? \n- [ ] Are there some test cases, input or edge cases\nthat should be tested in addition?\n\n## Readability\n- [ ] Is the code easy to understand?\n- [ ] Which parts were confusing to you and why?\n- [ ] Can the readability of the code be improved by\nsmaller methods?\n- [ ] Can the readability of the code be improved by\ndifferent function, method or variable names?\n- [ ] Is the code located in the right\nfile/folder/package?\n- [ ] Do you think certain methods should be\nrestructured to have a more intuitive control\nflow?\n- [ ] Is the data flow understandable?\n- [ ] Are there redundant or outdated comments?\n- [ ] Could some comments convey the message\nbetter?\n- [ ] Would more comments make the code more\nunderstandable?\n- [ ] Could some comments be removed by making the code itself more readable?\n- [ ] Is there any commented-out code?\n\n## Experts' Opinion\n- [ ] Do you think a specific expert, like a security\nexpert or a usability expert, should look over\nthe code before it can be accepted?\n- [ ] Will this code change impact different teams, and should they review the change as well?\n\nFor more insights into code reviews go to [awesomecodereviews.com](https://www.awesomecodereviews.com/).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmgreiler%2Fcode-review-checklist","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmgreiler%2Fcode-review-checklist","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmgreiler%2Fcode-review-checklist/lists"}