mirror of
https://github.com/rsyslog/rsyslog.git
synced 2025-12-15 19:50:40 +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.
13 lines
538 B
YAML
13 lines
538 B
YAML
# Copy this file into a contrib module directory and adjust values.
|
|
support_status: contributor-supported # contributor-supported | stalled
|
|
maturity_level: fresh # fully-mature | mature | fresh | experimental | deprecated
|
|
primary_contact: "GitHub Discussions & Issues <https://github.com/rsyslog/rsyslog/discussions>"
|
|
last_reviewed: 2024-01-01
|
|
build_dependencies: []
|
|
runtime_dependencies: []
|
|
ci_targets: []
|
|
documentation: []
|
|
support_channels: []
|
|
notes: |-
|
|
Document manual setup steps and any missing CI coverage here.
|