19 Reviews
c24danli edited this page 2026-05-18 12:40:05 +00:00

This page dictates how we conduct our reviews.

  1. You are assigned to review an issue by the Issue Coordinator

  2. Read through the issue and relevant comments to grasp what the issue regards

  3. Read through the code/model/text and check if:

    • it follows set standards (found in Wiki)
    • it is adequately commented
    • any other issues exist

If issue does not change any file in Project, go to step 7

  1. Switch to issue branch in Git

  2. Pull changes

  3. Run code and tests and check that it works

  4. Write feedback in the Issue comments

  5. Cleary describe what you have reviewed, the Issue Coordinator should be completely aware of what you have reviewed, how, and in what way

  6. If no changes need to be made inform Issue Coordinator, otherwise the originally assigned developer

The Issue Coordinator will close the issue!

Template for review

Copy this template. Text surrounded by [] should be removed or replaced after copying.

# 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]
    + CSS standard [Use this section for CSS files]
        +[Here you write if the file follows the CSS code standards properly, and what parts need to be changed if they don't follow the standards]
    + Naming convention [Including filename ]
        + [Here you write if the Naming convention is followed If not write what needs to be fixed ]
    + Printed text uses and follows localization standards
       + [Here you write if the Localization 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 .....]

For a good example (that is not fully up to date with the latest version), please check out #261 (comment).