rsyslog/rsyslog
1
0
Fork 0
mirror of https://github.com/rsyslog/rsyslog.git synced 2025-12-16 05:10:40 +01:00
Code Issues Packages Projects Releases Wiki Activity
rsyslog/.github/instructions/docs.instructions.md
Rainer Gerhards a29cbd6d09
ci: add copilot support instruction files 
This adds repository-level instructions to guide GitHub Copilot in
producing higher quality and safer pull requests. It is part of the
"AI First" approach, aiming to improve contributor experience and
reduce review friction.

Impact: no change to runtime or user-facing behavior.

The new files under `.github/` provide scoped rules for Copilot across
documentation, plugins, and contrib modules. They emphasize alignment
with AGENTS.md, developer checklists, and module maps. Guardrails cover
quoting, doc structure, config conventions, and mandatory source
citations. The intent is to ensure AI-assisted edits follow existing
rsyslog patterns and remain minimal and test-backed.

These changes are additive only and have no effect on rsyslog code,
APIs, or operational semantics. They prepare the repo for more
consistent AI-assisted contributions.
2025-08-20 10:24:55 +02:00

561 B
Raw Permalink Blame History

applyTo
applyTo
doc/**

Copilot: Documentation (doc/**)

Read first: AGENTS.md and any doc structure guidance it references.

Rules:

  • Keep Sphinx/ReST simple and consistent; prefer RainerScript examples for new configs.
  • Parameter docs live on dedicated reference pages when applicable; wire them via toctree.
  • Use plain US-ASCII; avoid emojis and special spaces.
  • Keep pages AI-ingestion friendly: clear headings, short code blocks, minimal duplication.

Do not:

  • Invent new page structures; follow existing patterns and cross-linking.