kritikos-io/templates-dotnet
Template
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
2f1e580e4947b5ca94af0596169bb166d8d4fb4a
templates-dotnet/.github/instructions/adr.instructions.md
T
akritikosandCopilot 2f1e580e49 ✨ Adds documentation instructions for ADR, analyzers, and observability 
Introduces new markdown files detailing editing rules for ADRs,
guidelines for analyzer and style configuration, and best practices
for observability and feature flags. These documents aim to ensure
consistency and clarity in project documentation and code quality.

Co-authored-by: Copilot <copilot@github.com>
2026-04-25 16:30:51 +03:00

852 B
Raw Blame History

description, applyTo
description applyTo
Use when editing files under docs/adr/. Enforces ADR immutability and supersession rules. docs/adr/**

ADR Editing Rules

ADRs are append-only history. To create a new ADR, use the new-adr skill.

  • Accepted ADRs are immutable. Do not change Context, Decision Drivers, Considered Options, or Decision Outcome after acceptance — write a new ADR that supersedes instead.
  • Permitted edits to accepted ADRs: typo/grammar fixes, adding links to related ADRs, and updating the status field as part of supersession or deprecation.
  • Superseding: set the predecessor's frontmatter to status: superseded by ADR-NNNN, update its date, and add a back-link in its body. Never delete the predecessor.
  • Filenames are permanent. Do not renumber or rename existing ADRs even if numbers have gaps.
Reference in New Issue View Git Blame Copy Permalink