43 lines
1.1 KiB
Markdown
43 lines
1.1 KiB
Markdown
|
# AGENTS.md — Polisher-Control Repo Rules
|
||
|
|
|
||
|
|
This repository is an external-collaborator technical workspace for the P11 / Fullum / GigaBIT polisher-control implementation.
|
||
|
|
|
||
|
|
## Scope
|
||
|
|
|
||
|
|
Allowed work:
|
||
|
|
- Teensy firmware
|
||
|
|
- Raspberry Pi / host controller
|
||
|
|
- touchscreen/manual-mode workflow support
|
||
|
|
- host↔Teensy protocol
|
||
|
|
- telemetry/logging/run artifacts
|
||
|
|
- safety/interlocks/alarms/watchdogs
|
||
|
|
- machine capability profile
|
||
|
|
- tests, commissioning scripts, and technical docs
|
||
|
|
|
||
|
|
Out of scope:
|
||
|
|
- optical figuring strategy
|
||
|
|
- metrology interpretation
|
||
|
|
- optimization / calibration logic
|
||
|
|
- client/commercial context
|
||
|
|
- private Antoine notes / unrelated projects
|
||
|
|
- credentials or secrets
|
||
|
|
|
||
|
|
## Architecture rule
|
||
|
|
|
||
|
|
`polisher-control` executes. It does not decide strategy.
|
||
|
|
|
||
|
|
If a change affects architecture, telemetry names/units/rates, safety behavior,
|
||
|
|
protocol semantics, or v1 scope, log it as a proposal and ask Antoine before
|
||
|
|
treating it as accepted direction.
|
||
|
|
|
||
|
|
## Commit hygiene
|
||
|
|
|
||
|
|
Prefer small commits:
|
||
|
|
- `docs: ...`
|
||
|
|
- `firmware: ...`
|
||
|
|
- `host: ...`
|
||
|
|
- `test: ...`
|
||
|
|
- `config: ...`
|
||
|
|
|
||
|
|
Never commit real machine data, secrets, invoices, tokens, or private notes.
|