3.2.1: Standards: Phased Delivery with Checkpoints - rdkcentral/ut-core GitHub Wiki

RRDIR (Research, Review, Design, Implement, Release/Review)

The following phases will be followed for delivery, with checkpoints at each stage. Tasks will be grouped into GitHub features, which will coordinate the release of multiple phases of delivery. GitHub project plans should be used to track and update progress throughout the workflow.

1. Research (GitHub Task for Research/Design/Documentation)

• A GitHub task will be created to track research activities.
• Each component team will provide a list of suggested tests.
• The team will research the requirements and document findings.
• A proposal will be generated based on the research.

Checkpoint: Completed research and proposal documented in the GitHub task.

2. Review (Discussion & Documentation)

• The Architecture team will review the findings either in the GitHub task or the discussion forum, as required.
• Feedback from the Architecture team will be used to revise and refine the proposal.
• The revised proposal will be written up for formal review.

Checkpoint: Written-up and approved proposal, moving towards finalization.

3. Design (Wiki Documentation for Review)

• Based on the initial discussions, the design will be created to solidify the requirements.
• The design will be documented on a Wiki page for review.
• The Architecture team will review, provide feedback, and approve the design.
• Once the design is approved, the corresponding GitHub task for the design phase will be closed, as the task is now complete.

Checkpoint: Design approved, documented on the Wiki page, and the design task closed.

4. Implement (GitHub Task for Implementation)

• Once the design is approved, a new GitHub task will be created to track the implementation.
• The task will refer to the finalised design Wiki, which provides clear requirements for implementation.
• The new task will clearly define goals, acceptance criteria, and branch name.
• The Engineering team will begin implementation based on the design and raise a Pull Request (PR) for review.
• The Architecture team will review the PR, provide feedback, and ensure it meets the acceptance criteria.
• Once approved, the PR will be merged into the develop branch, and the implementation ticket will be closed.

Checkpoint: Completed implementation in the GitHub task, with the PR merged to develop and the implementation ticket closed.

5. Review and Release

• The Release Team will handle the release process during the release cadence.
• The Release Team will review the final merged code, tag it as required, and follow the release process outlined in the FAQ: Release Engineers: Performing a release with git flow.

Checkpoint: Release tagged and ready for deployment.