summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorHa Thach <[email protected]>2025-10-09 12:12:23 +0700
committerGitHub <[email protected]>2025-10-09 12:12:23 +0700
commit97f814a3e0442424181e8c1c85aee9f8266b6536 (patch)
tree9a405d3a06c3a67888b7914f4226092989e5419c
parent2f90d7b6e5686828142155481628a264ae608de0 (diff)
Update AGENTS.md
Co-authored-by: Copilot <[email protected]>
-rw-r--r--AGENTS.md5
1 files changed, 4 insertions, 1 deletions
diff --git a/AGENTS.md b/AGENTS.md
index 3c4fe7298..7d727ef8a 100644
--- a/AGENTS.md
+++ b/AGENTS.md
@@ -30,6 +30,9 @@
## Claude Agent Notes (`CLAUDE.md`)
- Default to CMake+Ninja for builds, but align with Make workflows when users rely on legacy scripts; provide DEBUG/LOG/LOGGER knobs consistently.
- Highlight dependency helpers (`tools/get_deps.py rp2040`) and reference core locations: `src/`, `hw/`, `examples/`, `test/`.
-- Enforce code quality: clang-format on touched files, TU_ASSERT for fallible calls, header comments retaining MIT notice, and descriptive comments for non-trivial code paths.
+- Run `clang-format` on all touched files to ensure consistent formatting.
+- Use `TU_ASSERT` for all fallible calls to enforce runtime checks.
+- Ensure header comments retain the MIT license notice.
+- Add descriptive comments for non-trivial code paths to aid maintainability.
- Release flow primer: bump `tools/make_release.py` version, run the script (updates `src/tusb_option.h`, `repository.yml`, `library.json`), refresh `docs/info/changelog.rst`, then tag.
- Testing reminders: Ceedling full or targeted runs, specify board/OS context, and ensure logging of manual hardware outcomes when available.