mirror of
https://github.com/rsyslog/rsyslog.git
synced 2025-12-13 09:30:41 +01:00
b8d8faa68c
Improve AI-facing documentation to speed up contributor onboarding after the gpt5-codex agent update. The guides clarify bootstrap, testing, and where to find module ownership so agents can work predictably and avoid expensive CI-only paths. Impact: documentation-only; no runtime changes. Clarifies when to use direct test scripts vs. the autotools harness. This introduces repository-wide AGENTS guides (root, plugins/, contrib/, tools/, doc/) plus module-focused guides for omelasticsearch, imkafka, omkafka, and omruleset. It adds metadata templates for core and contrib modules, initial MODULE_METADATA.yaml files for the Kafka and ES modules, and a tools/MODULE_METADATA.json for built-ins. The top-level guide now includes quick links, “priming a fresh AI session,” and explicit autotools bootstrap instructions (run ./autogen.sh when autotools inputs change). Testing guidance asks agents to prefer invoking ./tests/*.sh directly, reserving `make check` for CI reproductions. The doc subtree gains its own AGENTS.md and an AI doc-builder base prompt to keep edits consistent. doc/ai/module_map.yaml was annotated to reference per-module metadata. Before: scattered or missing agent guidance; unclear when to bootstrap autotools or run the full harness. After: structured, discoverable docs, templates, and metadata that align contributor workflow across modules.
This directory contains a number of possibly useful things that do not directly relate to rsyslog. They are not actively supported, but as I said often helpful. Use them with some care, as they may be outdated in respect to the current release of rsyslog. At least some of this stuff has been found by our users and been included after a brief check and possibly an adaptation. If you have something useful you would like to see in contrib, just drop us a note (see https://www.rsyslog.com for how to do that at the time your are reading this document). rgerhards, 2007-08-08