Skip to content

Definition of Done (DoD)

Version Date Author Change Description
1.0 2025-09-11 Senior Systems Analyst Initial Draft

1. Introduction

This document provides the official Definition of Done (DoD) for all development tasks, features, and user stories within this project. The DoD is a shared, universal checklist that must be satisfied before any work can be considered complete.

Its purpose is to ensure that every feature delivered meets a consistent and high standard of quality, encompassing documentation, implementation, testing, and review. A task is not "done" simply when the code is written; it is "done" when it has met every criterion on this list.

2. The Universal Checklist

For a task (represented by a GitHub Issue) to be moved to the "Done" column on the project board, it must meet all of the following criteria:

Documentation

  • All Related Documents are Updated: All documentation related to the feature (BRD, Use Case, TRD, ADRs, etc.) has been updated to reflect the final state of the work within the same Pull Request.
  • Docs Reviewed & Approved: The documentation changes have been reviewed and approved by the relevant stakeholders (e.g., Business Analyst, System Architect).

Code & Implementation

  • Acceptance Criteria Met: The implementation successfully meets all acceptance criteria defined in the feature's BRD and its corresponding AI Task File (task.yml).
  • Code Standards Adhered To: The code is clean, well-commented, and adheres to the project's established coding standards and best practices.
  • No Hardcoded Secrets: No sensitive information (passwords, API keys, tokens) is hardcoded. All configuration is managed via environment variables as specified in the technical specifications.

Testing & Quality Assurance

  • Unit & Integration Tests Pass: All new and existing automated tests (unit, integration) pass successfully in the Continuous Integration (CI) pipeline.
  • Code Coverage Met: The automated tests for the new code meet or exceed the project's required code coverage threshold (e.g., >= 90%).
  • Test Plan Executed: The QA Engineer has fully executed the corresponding Test Plan against the feature in the Staging environment.
  • No Critical Defects: There are no open, unresolved defects of Critical or High severity related to the feature.

Final Review & Merge

  • Peer Review Approved: The Pull Request has been reviewed and formally approved by at least one other developer and the System Architect or Tech Lead.
  • Main Branch Merged: The feature branch has been successfully and cleanly merged into the main branch.
  • Staging Deployment Successful: The CI/CD pipeline has successfully deployed the changes from the main branch to the Staging environment.
  • QA Sign-off Received: The QA Engineer has given a final "Go" or sign-off after validating the feature on the Staging environment.