Skip to content

AGENTS.md

Latest commit

 

History

History
48 lines (29 loc) · 2.42 KB

AGENTS.md

File metadata and controls

48 lines (29 loc) · 2.42 KB

LibCANard instructions for AI agents

Read all README files in the project root and in all subdirectories except for lib/.

The applicable specifications can be found here:

Project layout:

  • libcanard: the library itself; the shippable code.
  • tests: the test harness. Read its own README for details.
  • lib: external dependencies.

Style conventions

Language targets: C99 for the library, C99 and C++20 for the test harness. Strict std only, compiler extensions not allowed.

Naming patterns: canard_* functions, canard_*_t types, CANARD_* macros. Internal definitions need no prefixing. Enums and constants are lower_snake_case. Uppercase only for macros.

Variables that are not mutated MUST be declared const, otherwise CI will reject the code.

Keep code compact and add brief comments before non-obvious logic.

Treat warnings as errors and keep compatibility with strict warning flags.

FORCE PUSH MUST NEVER BE USED. The git history is sacrosanct and must not be rewritten. If you need to undo a change, make a new commit.

For agent-authored commits, set GIT_AUTHOR_NAME="Agent" and GIT_COMMITTER_NAME="Agent".

The build system will reject code that is not clang-formatted; use build target format to invoke clang-format. This MUST be done before pushing code to avoid CI breakage.

Adversarial validation and verification

Practice an adversarial approach to testing: the purpose of a test case is not to provide coverage, but to empirically prove correctness of the tested code. Always treat the code as suspect; you will be rewarded for pointing out flaws in it. If the code does not appear to be correct, refuse to test it and provide evidence of its defects instead of proceeding with testing.

When using subagents to implement tests, always instruct them to summarize their findings concerning the correctness of the tested code and its possible limitations at the end of their run. At the end of the turn, provide a summary of the findings.

To run tests with coverage measurement:

cmake -B build -DENABLE_COVERAGE=ON     # Optionally, add  -DNO_STATIC_ANALYSIS=ON
cmake --build build -j$(nproc)
cd build && ctest && make coverage
xdg-open coverage-html/index.html

Coverage should focus on canard.c only. Coverage of other components is irrelevant.