22 lines
1.4 KiB
Markdown
22 lines
1.4 KiB
Markdown
# Repository convention discovery (Step 0)
|
|
|
|
No template or target URL was supplied with the request, so this repository records the conventions used as the implementation baseline rather than claiming an external inspection. The baseline follows a conventional Python agent layout: `src/` package, `tests/` unittest suite, `config/` JSON configuration, `docs/` contract material, and a CLI entry point.
|
|
|
|
## Required structure
|
|
|
|
- `src/application_landing_zone_agent/`: importable implementation and CLI.
|
|
- `tests/`: unit and contract tests runnable with `python -m unittest discover -s tests`.
|
|
- `config/default.json`: checked-in, dependency-free configuration.
|
|
- `docs/agent-specification.md`: behavior, contracts, workflow, and validation.
|
|
- `examples/`: human-reviewable input fixture.
|
|
- `pyproject.toml`: package metadata and console script.
|
|
|
|
## Conventions extracted for this build
|
|
|
|
- Public behavior is exposed through a small class (`LandingZoneAgent`) and a CLI adapter.
|
|
- Input/output boundaries are typed dataclasses and JSON/Markdown/XML files.
|
|
- Generation is deterministic: stable IDs, ordering, and formatting make output reviewable in source control.
|
|
- Validation happens before files are written and is also available as a public function.
|
|
- Diagram output is native draw.io `mxfile` XML, not an image or proprietary binary.
|
|
- Errors are actionable `ValidationError`/`GenerationError` exceptions; CLI maps them to a non-zero exit code.
|