Skip to content

Changes

Page history
Update review guide authored by Lukas Schattenhofer's avatar Lukas Schattenhofer
Hide whitespace changes
Inline Side-by-side
2-Guides/review-guide.md
View page @ ae897892
......@@ -12,17 +12,15 @@ By your review you'll assess whether a certain piece of hardware qualifies as op
## Overview
Review happens in corresponding issues on the CAB's GitLab instance. They should be self-explanatory; essentially there 4 types of review issues:
* `[assessment][main] <project-name>`
* that's just for the overview; no need to do anything here; however, you're free to view and comment general things, especially to give recommendations for the project development beyond the requirements of the assessment.
* `[assessment][some-category]`
* self-designed parts of a certain category (e.g. 3D printed parts) so that reviewers with specific knowledge can be invited
* each one must be checked individually
* `[assessment][ASM]`
* review of the assembly
* `[assessment][STD]`/`[assessment][BUY]`
* squashed review for referenced parts; in most cases these are standard and proprietary components
Review happens in corresponding issues on the CAB's GitLab instance. They should be self-explanatory and may differ based on the projects structure. Usually we divide projects in different subgroups so you can go through the project step by step.
Two Issues will always be there:
* `[Review][main] <project-name>`
* that's just for the overview; no need to do anything here; however, you're free to view and comment general things, especially to give recommendations for the project development beyond the requirements of the assessment.
* `[Review][License] <project-name>`
* Here you need to check if the project is licensed appropriately. Sometimes this issue is within the main issue.
* `[Review][subgroup] <project-name>`
* Here you will start checking if enough information is available to purchase all parts of the sub assembly, if the appropriate files are delivered for rebuilding and if the assembly instruction is sufficient and understandable. For more detailed information on what to check, see the section [What to Review](## What to review) below.
All relevant discussions & decisions are directly documented in the issue as comments.
......