Change #231488

Comments

docs: restructure contributor docs for clarity and AI agent readiness
This commit updates all contributor-facing documentation:

- **README.md**: Modernized structure and clarified installation/build sections. Removed obsolete local doc references and replaced with link to rsyslog-doc project.
- **CONTRIBUTING.md**: Refactored for clarity, added guidance for AI-generated code (e.g. commit prefix `AI:`), formalized use of draft PRs for experiments, and removed outdated advice on "testing new releases." Added rationale for continued use of `master` branch due to ecosystem dependencies.
- **AGENTS.md** (new): Introduces clear guidelines for AI-based agents contributing to rsyslog. Includes commit formatting, PR branch expectations, testing environment, and behavioral rules.

**Why now?**
Over the past two years, we've continuously evaluated the evolving capabilities of AI development agents. We now consider them mature enough to be integrated into the rsyslog development workflow—under careful human review. This documentation update provides the foundation to onboard such agents in a controlled, auditable, and high-quality manner.

All changes prioritize traceability and developer clarity—both human and AI.

closes: https://github.com/rsyslog/rsyslog/issues/5657

Changed files

• AGENTS.md
• CONTRIBUTING.md
• README.md