Refactor documentation for clarity and consistency, update test function naming convention

This commit is contained in:
2026-03-29 15:01:08 +02:00
parent 2ec2fcd2ab
commit 6236717fdb
4 changed files with 57 additions and 24 deletions
+11 -2
View File
@@ -2,11 +2,13 @@
## Purpose
This Definition of Done defines the minimum quality bar for every completed change in this repository.
This Definition of Done defines the minimum quality bar
for every completed change in this repository.
## Mandatory Criteria
1. Tests
- Every code change is covered by tests where applicable.
- New functionality includes new tests.
- Bug fixes include at least one regression test.
@@ -14,10 +16,12 @@ This Definition of Done defines the minimum quality bar for every completed chan
- Automated test coverage is at least 80%.
1. Functional documentation
- Implemented functionality is documented.
- Public API-relevant changes are reflected in README and/or docs.
1. Documentation standards
- Documentation is written in English.
- Documentation files are placed under `docs/`.
- Exceptions: `README.md` and `AGENTS.md` remain at repository root.
@@ -25,17 +29,22 @@ This Definition of Done defines the minimum quality bar for every completed chan
## Technical Completion Criteria
1. Build and test status
- The project builds successfully.
- Relevant test commands run successfully.
1. No unresolved critical issues
- No new blocking errors are introduced.
- Known non-blocking warnings are acceptable only if unrelated to the change or documented.
- Known non-blocking warnings are acceptable only if unrelated
to the change or documented.
1. SonarQube status
- No SonarQube errors are present.
1. Documentation links and structure
- Links to moved or newly added docs are valid.
- Documentation structure remains consistent with project rules.