NetarchiveSuite|
Size: 2203
Comment:
|
← Revision 34 as of 2010-08-16 10:25:11 ⇥
Size: 6269
Comment: converted to 1.6 markup
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 1: | Line 1: |
| ~+'''Reviews in Iteration <XX>'''+~ | ~+'''Reviews in Iteration <XX>'''+~<<BR>> ~-Use IterationReviewsOverviewTemplate template to start new review pages.-~ |
| Line 3: | Line 4: |
| Review of code should happen immediately after coding for a task or bug is done, so as little as possible is based on unreviewed code. | Contains: ~-[[#CodeReViewTplCrTable|Code Review Table]]-~, ~-[[#CodeReViewTplOrTable|Document Review Table]]-~, ~-[[#CodeReViewTplCrColumns|Code Review Column Description]]-~, ~-[[#CodeReViewTplOrColumns|Document Review Column Description]]-~ |
| Line 5: | Line 6: |
| If the reviewer for some reason cannot be contacted within a reasonable time frame, another reviewer should be chosen. | <<Anchor(CodeReViewTplCrTable)>> '''''Code Reviews'''''<<BR>> Description of columns can be found in section [[#CodeReViewTplCrColumns|Explanation of the columns in Code Review table]]. <<BR>> For details on how to do a code review, see [[Process/Code Review|Code Review Process]]. <<BR>> Code Reviews are done in the review-tool Crucible: [[http://kb-prod-udv-001.kb.dk:8060/|Link to Crucible]], export is done via [[http://kb-prod-udv-001.kb.dk:8060/plugins/servlet/export|Crucible export function]] <<BR>> Template for insertion of a new line in edit mode: <<BR>> `|| [http://kb-prod-udv-001.kb.dk:8060/cru/NS-XX NS-XX] || Bug/FR XXX || INIT || INIT || YYYY/MM/DD || IssuesFromNsXX || INIT || - || - || - ||` |
| Line 7: | Line 14: |
| Implementation time including coding, documentation and review is noted under information on issues found. | ||<bgcolor="#dddddd" style="text-align: center;">'''Review Id''' <<BR>> ~-NS-XX-~ ||<bgcolor="#dddddd" style="text-align: center;">'''Task''' <<BR>> ~-Bug/FR XXX-~ ||<bgcolor="#dddddd" style="text-align: center;">'''Author(s)'''<<BR>> ~-INIT-~ ||<bgcolor="#dddddd" style="text-align: center;">'''Reviewer(s)''' <<BR>> ~-INIT-~ ||<bgcolor="#dddddd" style="text-align: center;">'''Review date''' <<BR>> ~-YYYY/MM/DD-~ ||<bgcolor="#dddddd" style="text-align: center;">'''Issues found''' <<BR>> ~-IssuesFromNsXX-~ ||<bgcolor="#dddddd" style="text-align: center;">'''Follow-up''' <<BR>> ~-INIT-~ ||<bgcolor="#dddddd" style="text-align: center;">'''Done''' <<BR>> ~--, OK, OK-wp-~ || || NS-XX || Bug/FR XXX || INIT || INIT || YYYY/MM/DD || IssuesFromNsXX || INIT || - || |
| Line 9: | Line 17: |
| For details on how to do a code review, see [:Process/Code_Review_WithTitle:Code Review Process]. ||<bgcolor="#dddddd" style="text-align: center;">'''[:Code Review Process#TableFilledReviewsOverview:Class/Page]''' ||<bgcolor="#dddddd" style="text-align: center;">'''[:Code Review Process#TableFilledReviewsOverview:Version]''' ||<bgcolor="#dddddd" style="text-align: center;">'''[:Code Review Process#TableFilledReviewsOverview:Lines/parts]''' ||<bgcolor="#dddddd" style="text-align: center;">'''[:Code Review Process#TableFilledReviewsOverview:Task]''' ||<bgcolor="#dddddd" style="text-align: center;">'''[:Code Review Process#TableFilledReviewsOverview:Author(s)]''' ||<bgcolor="#dddddd" style="text-align: center;">'''[:Code Review Process#TableFilledReviewsOverview:Reviewer(s)]''' ||<bgcolor="#dddddd" style="text-align: center;">'''[:Code Review Process#TableFilledReviewsOverview:Review date]''' ||<bgcolor="#dddddd">'''[:Code Review Process#TableFilledReviewsOverview:Follow-up]''' ||<bgcolor="#dddddd" style="text-align: center;">'''[:Code Review Process#TableFilledReviewsOverview:Done]''' || || <Link to code review page for class/JSP-page named with java path name, f.ex. dk.netarkivet.harvestdefinition.JobDAO> || <SVN version of code being reviewed> || <Lines/parts to review> || <Reference to task caused the code changes that are being reviewed as for example a bugs, a feature request or an assignment> || <Initials of author of changes in code> || <Initials of reviewer in code review> || <Date that review was held on form YYYY/MM/DD> || <Initials of person to do follow-up on code review> || <Must be either [[BR]] '''''Ok''''' (no further action), [[BR]] '''''Ok w/postponed''''' (no further action within this iteration, but includes postpones to be done later)> || |
<<Anchor(CodeReViewTplOrTable)>> '''''Document Reviews'''''<<BR>> Description of columns can be found in section [[#CodeReViewTplOrColumns|Explanation of the columns in Document Review table]].<<BR>> For details on how to other reviews, see [[Process/Document Review|Document Review Process]].<<BR>> Template for insertion of a new line in edit mode:<<BR>> `|| [:DocumentReview/DocNameIdReview:DocName] || Version || Lines || Bug/FR XXX || INIT || INIT || YYYY/MM/DD || INIT || - ||` ||<bgcolor="#dddddd" style="text-align: center;">'''Document''' <<BR>> ~-`[:link:docName]`-~ ||<bgcolor="#dddddd" style="text-align: center;">'''Version''' <<BR>> ~-X.Y/date-~ ||<bgcolor="#dddddd" style="text-align: center;">'''Lines/parts''' <<BR>> ~-All/x-y-~ ||<bgcolor="#dddddd" style="text-align: center;">'''Task''' <<BR>> ~-Bug/FR XXX-~ ||<bgcolor="#dddddd" style="text-align: center;">'''Author(s)'''<<BR>> ~-INIT-~ ||<bgcolor="#dddddd" style="text-align: center;">'''Reviewer(s)''' <<BR>> ~-INIT-~ ||<bgcolor="#dddddd" style="text-align: center;">'''Review date''' <<BR>> ~-YYYY/MM/DD-~ ||<bgcolor="#dddddd" style="text-align: center;">'''Follow-up''' <<BR>> ~-INIT-~ ||<bgcolor="#dddddd" style="text-align: center;">'''Done''' <<BR>> ~--, OK, OK-wp-~ || || [[DocumentReview/DocNameIdReview|DocName]] || Version || Lines || Bug/FR XXX || INIT || INIT || YYYY/MM/DD || INIT || - || <<Anchor(CodeReViewTplCrColumns)>> '''''Explanation of the columns in Code Review table:''''' * "Review Id": The Crucible Review Id which the review is created under in Crucible. Normally name is on form NS-XX, i.e. text to be inserted is `[http://kb-prod-udv-001.kb.dk:8060/cru/NS-XX NS-XX]` * "Task": The assignment or tracker issue that the code has been updated for, e.g. Bug 1512. * "Author(s)": The person(s) who have made changes or additions to the code. Only Initials are given, e.g. ELZI. * "Reviewer(s)": The person(s) who have not been involved in coding these changes, who will participate in the review. * "Review date": Date for review. * "Issues found": Link to wiki page with issues found under review (and mandays of work). Normally on form IssuesFromNsXX. * "Follow-up": The person who will do the follow-up on the review specified under 'Issues found'. * "Done": whether the review follow-up has been done. Has value "'''-'''" if new, "'''OK'''" if all follow-ups are done, "'''OK-wp'''" (with postpones) if follow-ups are done with exceptions that have been postponed. * "Release Test": Whether the changes are to be included in the Release test. Has values "'''-'''" if new, "'''incl.'''" if it is to be included in the release test and "'''excl.'''" if it cannot be included in the release test (e.g. if not testable). * "Manuals": The manuals that has to be/is updated as a concequence of the change. Has values "'''-'''" if new, "'''Quick'''" for [[Quick Start Manual devel| Quick Start Manual]], "'''Deploy'''" for [[Deploy Manual devel| Deploy Manual]], "'''Conf.'''" for [[Configuration Manual devel| Configuration Manual]], "'''Inst..'''" for [[Installation Manual devel| Installation Manual]], "'''Dev.'''" for [[Developer Manual devel| Developer Manual]], "'''User'''" for [[User Manual devel| User Manual]]. <<Anchor(CodeReViewTplOrColumns)>> '''''Explanation of the columns in Document Review table:''''' * "Document": Link to issue review page for document named with identification of the document, e.g. http://netarchive.dk/suite/AssignmentDeploy1 - See example in [Iteration 36]. * "Version": The SVN, CVS or date for revision of document/script to be reviewed. * "Parts/lines": Specifies the parts of the document/script to review (if less that the whole file). * "Task": The assignment or tracker issue that the code has been updated for, e.g. Bug 1512. * "Author(s)": The person(s) who have made changes or additions to the code. Only Initials are given, e.g. ELZI. * "Reviewer(s)": The person(s) who have not been involved in coding these changes, who will participate in the review. * "Review date": Date for review. * "Follow-up": The person who will do the follow-up on the review specified under 'Issues found'. * "Done": whether the review follow-up has been done. Has value "'''-'''" if new, "'''OK'''" if all follow-ups are done, "'''OK-wp'''" (with postpones) if follow-ups are done with exceptions that have been postponed. |
Reviews in Iteration <XX>
Use IterationReviewsOverviewTemplate template to start new review pages.
Contains: Code Review Table, Document Review Table, Code Review Column Description, Document Review Column Description
Code Reviews
Description of columns can be found in section Explanation of the columns in Code Review table.
For details on how to do a code review, see Code Review Process.
Code Reviews are done in the review-tool Crucible: Link to Crucible, export is done via Crucible export function
Template for insertion of a new line in edit mode:
|| [http://kb-prod-udv-001.kb.dk:8060/cru/NS-XX NS-XX] || Bug/FR XXX || INIT || INIT || YYYY/MM/DD || IssuesFromNsXX || INIT || - || - || - ||
Review Id |
Task |
Author(s) |
Reviewer(s) |
Review date |
Issues found |
Follow-up |
Done |
NS-XX |
Bug/FR XXX |
INIT |
INIT |
YYYY/MM/DD |
IssuesFromNsXX |
INIT |
- |
Document Reviews
Description of columns can be found in section Explanation of the columns in Document Review table.
For details on how to other reviews, see Document Review Process.
Template for insertion of a new line in edit mode:
|| [:DocumentReview/DocNameIdReview:DocName] || Version || Lines || Bug/FR XXX || INIT || INIT || YYYY/MM/DD || INIT || - ||
Document |
Version |
Lines/parts |
Task |
Author(s) |
Reviewer(s) |
Review date |
Follow-up |
Done |
Version |
Lines |
Bug/FR XXX |
INIT |
INIT |
YYYY/MM/DD |
INIT |
- |
Explanation of the columns in Code Review table:
"Review Id": The Crucible Review Id which the review is created under in Crucible. Normally name is on form NS-XX, i.e. text to be inserted is [http://kb-prod-udv-001.kb.dk:8060/cru/NS-XX NS-XX]
- "Task": The assignment or tracker issue that the code has been updated for, e.g. Bug 1512.
- "Author(s)": The person(s) who have made changes or additions to the code. Only Initials are given, e.g. ELZI.
- "Reviewer(s)": The person(s) who have not been involved in coding these changes, who will participate in the review.
- "Review date": Date for review.
- "Issues found": Link to wiki page with issues found under review (and mandays of work). Normally on form IssuesFromNsXX.
- "Follow-up": The person who will do the follow-up on the review specified under 'Issues found'.
"Done": whether the review follow-up has been done. Has value "-" if new, "OK" if all follow-ups are done, "OK-wp" (with postpones) if follow-ups are done with exceptions that have been postponed.
"Release Test": Whether the changes are to be included in the Release test. Has values "-" if new, "incl." if it is to be included in the release test and "excl." if it cannot be included in the release test (e.g. if not testable).
"Manuals": The manuals that has to be/is updated as a concequence of the change. Has values "-" if new, "Quick" for Quick Start Manual, "Deploy" for Deploy Manual, "Conf." for Configuration Manual, "Inst.." for Installation Manual, "Dev." for Developer Manual, "User" for User Manual.
Explanation of the columns in Document Review table:
"Document": Link to issue review page for document named with identification of the document, e.g. http://netarchive.dk/suite/AssignmentDeploy1 - See example in [Iteration 36].
- "Version": The SVN, CVS or date for revision of document/script to be reviewed.
- "Parts/lines": Specifies the parts of the document/script to review (if less that the whole file).
- "Task": The assignment or tracker issue that the code has been updated for, e.g. Bug 1512.
- "Author(s)": The person(s) who have made changes or additions to the code. Only Initials are given, e.g. ELZI.
- "Reviewer(s)": The person(s) who have not been involved in coding these changes, who will participate in the review.
- "Review date": Date for review.
- "Follow-up": The person who will do the follow-up on the review specified under 'Issues found'.
"Done": whether the review follow-up has been done. Has value "-" if new, "OK" if all follow-ups are done, "OK-wp" (with postpones) if follow-ups are done with exceptions that have been postponed.