Add project standards files and scripts for consistency

2026-03-29 17:36:47 +02:00
parent 80f27aa392
commit 66789d67ad
8 changed files with 499 additions and 0 deletions
@@ -0,0 +1,52 @@
+# Definition of Done (DoD)
+
+## Purpose
+
+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.
+- For Go projects, tests use `github.com/smartystreets/goconvey`.
+- 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.
+
+## 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.
+
+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.
+
+## 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/` (except `README.md` and `AGENTS.md`).
+- [ ] No SonarQube errors are present.
+- [ ] No critical regressions found.