mirror of
https://gitee.com/pnoker/iot-dc3.git
synced 2026-11-02 03:01:52 +08:00
Introduce dc3/doc/TESTING.md as the canonical reference for the iot-dc3 test pyramid, naming conventions, time/randomness isolation rules, Testcontainers conventions pinned to the production timescaledb-ha:pg18 image, fixture data strategy, contract base classes shipped by dc3-common-test, the make commands developers run locally and the ci.yml/test.yml/e2e.yml workflow contract. Update AGENTS.md so: - The Validation Checklist references make test, make test-it, make coverage and proto contract tests; coverage regressions over 1% block PRs. - The Documentation Rules section now lists TESTING.md alongside the other domain-specific docs to keep the guide current as the harness evolves. This closes the S0 stage of the test build-out: every subsequent stage (S1..S8) will deliver business test cases under the layout defined here.
IoT DC3 Documentation
This directory contains project-level documentation for local development, deployment, troubleshooting, and driver authoring.
| Document | Purpose |
|---|---|
| USAGE.md | Container image usage and registry options |
| QUICKSTART.md | Local source-code development workflow |
| MODULES.md | Maven module map and runtime flow |
| ENVIRONMENT.md | Environment variable usage and purpose |
| LOGGING.md | Application logging format and usage guidelines |
| DRIVER-AUTHORING.md | Guide for creating a new protocol driver |
| TROUBLESHOOTING.md | Common build and runtime issues |
| CHANGE.md | Release change notes |
| TITLE.md | Release title and short project introduction |
Unless stated otherwise, commands in these documents should be run from the repository root.