Skip to content

docs: add AGENTS.md for coding agents - #5491

Merged
Watson1978 merged 2 commits into
fluent:masterfrom
Watson1978:add-agents-md
Sep 7, 2026
Merged

docs: add AGENTS.md for coding agents#5491
Watson1978 merged 2 commits into
fluent:masterfrom
Watson1978:add-agents-md

Conversation

@Watson1978

Copy link
Copy Markdown
Contributor

Which issue(s) this PR fixes:
Fixes #

What this PR does / why we need it:
AI coding agents working on this repository keep rediscovering the same basics, and they guess at plugin parameters instead of reading the documentation.

This adds AGENTS.md, the cross-tool convention read by Claude Code, Cursor, Codex and Copilot. It points agents at docs.fluentd.org (including the llms.txt index and the .md suffix that serves any page as Markdown), sketches the repository layout, and restates the contributor rules that matter most: DCO sign-off, tests under test/, and no new runtime dependencies without discussion. Humans are still directed to CONTRIBUTING.md.

Docs Changes:
N/A

Release Note:
N/A

@Watson1978 Watson1978 added this to the v1.20.0 milestone Sep 7, 2026
@Watson1978
Watson1978 requested a review from kenhys September 7, 2026 06:22
AI coding agents keep rediscovering the same basics: where bundled
plugins live, how to run a single test file, and that commits need a
DCO sign-off. They also guess at plugin parameters instead of reading
the docs, and open pull requests that ignore the template because
`gh pr create --body` never applies it. Record that context once so
agents start from facts.

Signed-off-by: Shizuo Fujita <fujita@clear-code.com>
Comment thread AGENTS.md
Fluentd is tested on Linux, macOS and Windows, but agents tend to
assume a POSIX-only environment. Record the CI platform matrix so
Windows is considered up front.

Signed-off-by: Shizuo Fujita <fujita@clear-code.com>
@Watson1978
Watson1978 requested a review from kenhys September 7, 2026 06:48
@Watson1978
Watson1978 merged commit 97fff10 into fluent:master Sep 7, 2026
4 of 7 checks passed
@Watson1978
Watson1978 deleted the add-agents-md branch September 7, 2026 06:52
@Watson1978

Copy link
Copy Markdown
Contributor Author

Thanks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants