1.7 KiB
1.7 KiB
Definition of Done (DoD)
Purpose
This Definition of Done defines the minimum quality bar for every completed change in this repository.
Mandatory Criteria
- Tests
- Every code change is covered by tests where applicable.
- New functionality includes new tests.
- Bug fixes include at least one regression test.
- For Go projects, tests use
github.com/smartystreets/goconvey. - Automated test coverage is at least 80%.
- Functional documentation
- Implemented functionality is documented.
- Public API-relevant changes are reflected in README and/or docs.
- Documentation standards
- Documentation is written in English.
- Documentation files are placed under
docs/. - Exceptions:
README.mdandAGENTS.mdremain at repository root.
Technical Completion Criteria
- Build and test status
- The project builds successfully.
- Relevant test commands run successfully.
- No unresolved critical issues
- No new blocking errors are introduced.
- Known non-blocking warnings are acceptable only if unrelated to the change or documented.
- SonarQube status
- No SonarQube errors are present.
- Documentation links and structure
- Links to moved or newly added docs are valid.
- Documentation structure remains consistent with project rules.
Review Checklist (Quick)
- Change is implemented and meets acceptance criteria.
- Tests were added/updated and pass.
- Go tests use
github.com/smartystreets/goconvey. - Automated test coverage is at least 80%.
- Functionality is documented.
- Documentation is in English.
- Documentation is located under
docs/(exceptREADME.mdandAGENTS.md). - No SonarQube errors are present.
- No critical regressions found.