We need a review "check-list" #300

Closed
opened 2026-04-15 07:08:43 +00:00 by a24vinla · 4 comments
Collaborator

To further standardize and simplify the review process we should create a template/check-list that reviewers can follow.

To further standardize and simplify the review process we should create a template/check-list that reviewers can follow.
Author
Collaborator

Add this to the wiki-page when reviewed!

Add this to the [wiki-page](https://git.webug.se/Andras/BoundlessFlowCampus2K/wiki/Reviews) when reviewed!
Collaborator

Review on #[Number of issue reviewed]

Whats done

[Review following things]

Tested on [Name of OS] using [Name of browser]

  • [Focus on checking features that the issue intended to solve/implement]
  • App starts [IF the app starts]
    • [Here you write possible issues found e.g " HTTP 404 from TemperatureView", image overflow container "Name" ]
    • [You should also write the things you have tested. e.g,Tested login in as user and guest. Checked it worked as intended]

Inspected following files [IMPORTANT!, Don't forget to inspect for unapproved dependencies in package.json ]

  • [Name of inspected file]
    • [Check following things]
    • Indentation/code styling [does it follow prettier]
      • [Writes Indentation is ok or problems noted]
    • Naming convention [Including filename ]
      • [Here you write if the Naming convention is followed If not write what needs to be fixed ]
    • Comments
      • [Follows standard. If the reviewer sees the need for more/less comments]
    • General code quality
      • [Any general issues you found in the code i.e unnecessarily complex code, logic flaws and unused imports ]

What needs to be done

[Here you should write the things that needs to be fixed.]

  • [Location]
    • [What needs to be done, e.g Fix the indentation to follow css standard]

Conclusion

  • [Here you write your conclusion after the review. i.e if the code is ready for merge or needs to be improved]
  • [Optional, general observation e.g no standard for .....]
# Review on #[Number of issue reviewed] ## Whats done [Review following things] ### Tested on [Name of OS] using [Name of browser] + [Focus on checking features that the issue intended to solve/implement] + App starts [IF the app starts] + [Here you write possible issues found e.g " HTTP 404 from TemperatureView", image overflow container "Name" ] + [You should also write the things you have tested. e.g,Tested login in as user and guest. Checked it worked as intended] ### Inspected following files [IMPORTANT!, Don't forget to inspect for unapproved dependencies in **package.json** ] + [Name of inspected file] + [Check following things] + Indentation/code styling [does it follow prettier] + [Writes Indentation is ok or problems noted] + Naming convention [Including filename ] + [Here you write if the Naming convention is followed If not write what needs to be fixed ] + Comments + [Follows standard. If the reviewer sees the need for more/less comments] + General code quality + [Any general issues you found in the code i.e unnecessarily complex code, logic flaws and unused imports ] ## What needs to be done [Here you should write the things that needs to be fixed.] + [Location] + [What needs to be done, e.g Fix the indentation to follow css standard] ## Conclusion + [Here you write your conclusion after the review. i.e if the code is ready for merge or needs to be improved] + [Optional, general observation e.g no standard for .....]
Collaborator
Can be found on wiki page https://git.webug.se/Andras/BoundlessFlowCampus2K/wiki/Reviews#template-for-review
Collaborator

The structure of the template is good as it prompts the reviewer to check everything required from the general code quality to the implementation. So the template works well as a support tool to ensure consistency and to make reviews easier to manage and do.

The clear sections for testing, file inspection and required changes make it straightforward to communicate what has been review and what needs attention. Which leads to both developer and Coordinator to quickly understand the outcome of the review without needing additional inputs.

The structure of the template is good as it prompts the reviewer to check everything required from the general code quality to the implementation. So the template works well as a support tool to ensure consistency and to make reviews easier to manage and do. The clear sections for testing, file inspection and required changes make it straightforward to communicate what has been review and what needs attention. Which leads to both developer and Coordinator to quickly understand the outcome of the review without needing additional inputs.
Sign in to join this conversation.
No milestone
No project
3 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
Andras/BoundlessFlowCampus2K#300
No description provided.