agents: document local overlay lookup

Why: Local Codex workflows need a clear place for machine-specific notes without copying those details into the shared guide.

Impact: Agents are now explicitly directed to read the ignored local overlay when it exists.

Before/After: The guide only implied local notes; it now defines the overlay lookup at the top.

Technical Overview:

Add a Local Overlay section near the start of AGENTS.md.

Mirror the liblognorm wording so related repositories use the same convention.

Keep machine-specific instructions in AGENTS.local.md, which remains ignored.

No source, build, or test behavior changes are introduced.

With the help of AI-Agents: Codex
This commit is contained in:
Rainer Gerhards 2026-05-13 17:04:34 +02:00
parent 541be42223
commit 5dad72d656

View File

@ -2,6 +2,12 @@
This file defines the high-level roadmap for AI assistants to understand and contribute to the rsyslog codebase. Technical workflows are now modularized into **Skills**.
## Local Overlay
Before starting work in this repository, read `AGENTS.local.md` if it exists.
That file contains machine- and workflow-specific instructions that are not
duplicated here.
## AI Agent Skills
To ensure consistency and high-quality contributions, AI agents SHOULD use the following standardized skills located in `.agent/skills/`: