c-ares / c-ares / 28748353435
90%

DEFAULT BRANCH: main
Ran
Jobs 1
Files 176
Run time 1min
Badge
Embed ▾
README BADGES
x

If you need to use a raster PNG badge, change the '.svg' to '.png' in the link

Markdown

Textile

RDoc

HTML

Rst
coverage: 89.898%. Remained the same
28748353435

push

github

web-flow 
docs: add AGENTS.md and modernize contributor documentation (#1231)

## Summary

Adds a root `AGENTS.md` with the project's coding rules, written for AI
coding agents but applicable to all contributors, and promotes
`CONTRIBUTING.md` to the canonical contribution policy it references.
Also fixes stale documentation discovered while researching the rules.

## AGENTS.md

Seven hard rules up front (C89; no API/ABI breaks;
internal-library-first — extend it, never hand-roll; OOM returns errors
with LCOV annotations; tests + coverage; clang-format on changed lines;
never break interoperability), followed by compact build/test commands,
code conventions, a need→module table for the internal library, test
placement, docs, and security posture. Rules were extracted from actual
source/CI behavior with each verified against current main — most
existed only as tribal knowledge.

## CONTRIBUTING.md

Now the single written home for policy that was previously unwritten:
the >90% coverage requirement, the four canonical LCOV exclusion tags
(`OutOfMemory`, `DefensiveCoding`, `UntestablePath`, `FallbackCode`) and
when they're allowed, the API/ABI additive-only rule including the
current `ares_options` extension criteria (non-allocating members
appended with an `ARES_OPT_*` bit only; `ares_dup()` updated either
way), commit format with `Signed-off-by`, and man-pages-in-same-PR.

## Stale doc fixes

- `test/README.md`: rewritten — CMake+Ninja instructions, current
test-file layout (`-et`/`-ai`/container/symbol-hiding), correct fuzzer
description (`ares_dns_parse`→`ares_dns_write` round-trip + corpus
rule), modern coverage flow, C++14 (verified against
`test/CMakeLists.txt`). Removes references to `--enable-expose-statics`,
`ares-test-internal.c`, and `make code-coverage-capture`.
- `DEVELOPER-NOTES.md`: the `clang-format -i */*.c ...` glob (misses
nested dirs) replaced with `git clang-format` + the CI changed-lines
gate.
- `.reuse/dep5`: AGENTS.md added to the docs lice... (continued)

24143 of 26856 relevant lines covered (89.9%)

15913.02 hits per line

Coverage Regressions

Lines Coverage ∆ File
1
95.95
 -0.4% src/lib/ares_init.c
Jobs
ID Job ID Ran Files Coverage
1 28748353435.1 176
89.9
 GitHub Action Run
Source Files on build 28748353435