eSlider
ad7e0a5cbe
Document why WireGuard and SSH are complementary layers, add Flux boundaries for the ground segment, shared var/ data paths in docs/06, and a contributor guide with the required test-first workflow.
32 lines
1.7 KiB
Markdown
32 lines
1.7 KiB
Markdown
# AGENTS.md
|
|
|
|
Rules for anyone (human or tooling) contributing to this repository.
|
|
|
|
## Hard rules
|
|
|
|
1. **English only.** All documentation, code, comments, commit messages, and file names are written in English.
|
|
2. **No identifying references.** Never mention names of people, companies, organizations, or locations anywhere in this repository — not in docs, code, comments, or git history. This is a generic, self-contained design proposal for an on-prem data platform for autonomous drone swarms.
|
|
3. **Clean git history.** Commit messages must never reference AI assistants, code generation tools, or editors. No `Co-authored-by` trailers pointing to tools, no "Generated with ..." lines. Conventional commit format (`feat:`, `fix:`, `docs:`, `refactor:`).
|
|
4. **Push target.** The only remote is `origin` → `git.produktor.io`. Never mirror this repository anywhere else.
|
|
|
|
## Project layout
|
|
|
|
```
|
|
docs/ Design documentation (Markdown + Mermaid)
|
|
simulator/ Virtual drone fleet — Python data generator (Parquet/DuckDB pipeline)
|
|
prototype/ 2D swarm visualization — React + TypeScript (Vite)
|
|
infra/ Ansible host prep, Terraform workloads, Flux GitOps overlays
|
|
var/t1/ Shared T1 live lake (gitignored runtime data)
|
|
var/t3/ Shared T3 warehouse (gitignored runtime data)
|
|
```
|
|
|
|
See [`CONTRIBUTING.md`](CONTRIBUTING.md) for the development workflow and TDD requirements.
|
|
|
|
## Conventions
|
|
|
|
- Markdown: ATX headings, fenced code blocks with language tags, pipe tables.
|
|
- Python: PEP 8, type hints, pure functions where possible, no unnecessary classes.
|
|
- TypeScript: strict mode, functional components and hooks, no extra UI libraries.
|
|
- YAML: 2-space indent.
|
|
- Diagrams: Mermaid inside Markdown.
|