From 1cdc9d390a8f19644f3ddb1d013ca3bf6ec675b3 Mon Sep 17 00:00:00 2001 From: mnerv <24420859+mnerv@users.noreply.github.com> Date: Wed, 22 Apr 2026 05:03:54 +0200 Subject: [PATCH] Add AGENTS.md with conventions, markdown style, and commit guidelines --- AGENTS.md | 43 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) create mode 100644 AGENTS.md diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 0000000..3ff9e44 --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,43 @@ +# Agents + +## Conventions + +- Each build lives in its own directory named `-/` + (e.g. `3inch-walksnail/`) +- Betaflight CLI dumps go inside the build directory, named + `betaflight_dump.txt` +- Shared configs (rates, modes, VTX tables) go in the repo root or `radio/` as + appropriate +- README.md is the single source of truth for build specs — keep it in sync when + adding files + +## README format + +Each build section follows this field order: + +``` +- **Name:** +- **Frame:** +- **Prop size:** +- **FC:** +- **ESC:** +- **BF version:** +- **Receiver:** +- **ELRS firmware:** +- **VTX:** +- **Motor:** +- **Weight:** +``` + +Use ` - ` (hyphen) as the section separator, not em dash. + +## Markdown style + +- Wrap lines at 80 columns +- Tables may exceed 80 columns + +## Commit style + +- Imperative, sentence case, no period: `Add Lion build and CLI dump` +- No co-author lines +- Scope is implicit from the message — no conventional-commit prefixes needed