• Diff for "PackageCodeReviewTemplate"
Differences between revisions 5 and 6
Revision 5 as of 2009-07-27 17:42:11
Size: 1584
Editor: MeloneeWise
Comment:
Revision 6 as of 2009-07-28 06:45:21
Size: 1583
Editor: MeloneeWise
Comment:
Deletions are marked like this. Additions are marked like this.
Line 10: Line 10:
Examiner: Enter your notes on each section below. See [:examiner checklist] for more detailed instructions. Examiner: Enter your notes on each section below. See [:ExaminerChecklist] for more detailed instructions.

@PAGE@

Package Developer:

Examiner:

Present at code review:

Notes from examiner

Examiner: Enter your notes on each section below. See [:ExaminerChecklist] for more detailed instructions.

  • Divide your concerns up into bullet lists that can be run through in order in the meeting, and concretely decided about. Include enough details / relevant information for people at meeting to quickly decide on the issue (e.g. file and line number, description of race condition, or list unclear names)
  • {X} Use error symbol to call out things that are clear errors

  • /!\ Use warning symbol to call out things that you're worried about

  • (./) Use check mark to mark areas that look good.

  • Use the below bullets as a basic guide, but feel free to add new issues or remove issues that are not relevant (e.g. command-line options for a library)
  • Feel free to delete this instruction section when you're done

Documentation

  • API
  • ROS API
  • command-line
  • tutorials / examples

Naming

  • headers
  • libraries
  • exported symbols
  • ROS API

Source Code

  • header files
  • source files
  • data / configuration / xml files

Manifest / Build System

  • build
  • dependencies
  • manifest data

Testing

  • all tests pass
  • unit tests
  • rostests

Conclusions

This section will be filled out during the group code review meeting, and will include

  • /!\ Any action items that need to be taken before clearing

  • Change in official package status


Wiki: PackageCodeReviewTemplate (last edited 2009-08-14 20:53:46 by localhost)