For code reviews, we can use the following abbreviations:
LG: looks good, no obvious problems.
NW(#xx): needs work, please complete issue number xx
The template for code reviews will then be:
+-----------------------------------------
Style: (LG/NW/None)
Logic: (LG/NW/None)
Other: (LG/NW/None)
Summary:
Comments:
+-----------------------------------------
In the style section, create an issue for any major problems you see (lots of missing comments, etc) and comment on checkstyle-type problems.
In the logic section, create an issue for any major logic problems you find.
In the other section, create an issue for any other major problems you discover.
In the summary section, give a brief summary of what you think the commit changed.
In the comments section, add any other comments you think would be helpful.
An example code review filled out:
+-----------------------------------------
Style: LG
Logic: NW(#89) for infinite loop on line 35
Other: None
Summary: This build added a spinning logo feature for when the user arrives
Comments: Added a useful feature, but needs to address what happens if the boolean is set, which would result in an infinite loop (see issue #89)
+------------------------------------------
For code reviews, we can use the following abbreviations: LG: looks good, no obvious problems. NW(#xx): needs work, please complete issue number xx
The template for code reviews will then be: +----------------------------------------- Style: (LG/NW/None) Logic: (LG/NW/None) Other: (LG/NW/None) Summary: Comments: +-----------------------------------------
In the style section, create an issue for any major problems you see (lots of missing comments, etc) and comment on checkstyle-type problems.
In the logic section, create an issue for any major logic problems you find.
In the other section, create an issue for any other major problems you discover.
In the summary section, give a brief summary of what you think the commit changed.
In the comments section, add any other comments you think would be helpful.
An example code review filled out: +----------------------------------------- Style: LG Logic: NW(#89) for infinite loop on line 35 Other: None Summary: This build added a spinning logo feature for when the user arrives Comments: Added a useful feature, but needs to address what happens if the boolean is set, which would result in an infinite loop (see issue #89) +------------------------------------------