definition_of_done.md

Definition of done

This document clarifies, when a product backlog item is done. It will act as a checklist during the scrum development process. The individual points are a basis for acceptance criteria and are shortened or appended by specific measures as needed.

Documentation

• Public api function documentation (sphinx/doxygen are autogenerated online with diagrams embedded)
• Architecture documentation reflects actual code structure
• Tutorials
• Overview on ROS wiki
• Package Readme (example pilz_robots)
• Good commit messages (some tips)
• CHANGELOG.rst updated
• Copyright headers

Reviews

• Soft- and hardware architecture (diagrams and description)
• Test review (test plan and individual test cases)
• Documentation describes purpose of file(s) and responsibilities
• Code (coding rules, style guide)

Quality

• CI pass: The travis job (for example in pilz_robots) checks full code coverage, successful test execution and code formatting.

Demo

• Example program / snippet prepared (example at pilz_robot_programming)
• Ready for sprint review

Release planning

• When is the new feature released?
• Which dependent packages do have to be released simultaneously?

Cleanup

• Squash-Merge
• Delete feature branch(es)