rsyslog/rsyslog
1
0
Fork 0
mirror of https://github.com/rsyslog/rsyslog.git synced 2025-12-17 04:40:43 +01:00
Code Issues Packages Projects Releases Wiki Activity
rsyslog/.github/copilot-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

831 B
Raw Blame History

Copilot: Repository Operating Rules

Mandatory first step (for any task):

  1. Open and read:
    • AGENTS.md
    • DEVELOPING.md
    • MODULE_AUTHOR_CHECKLIST.md
    • doc/ai/module_map.yaml
  2. Reply with a short readiness summary:
    • 3–5 bullets of key constraints you will follow
    • Which paths/modules the task touches
  3. If any file is missing or unreadable, stop and ask.

Guardrails

  • Do not paraphrase long passages; quote exact lines and include file paths (and line ranges if available).
  • In plans/PRs, cite the source file(s) for every rule you apply.
  • Refuse work that conflicts with these files or bypasses them.

Style

  • Keep diffs minimal and well-scoped. Add tests/docs when behavior changes.
  • Prefer existing conventions stated in the files above. Do not invent new ones.