Skip to content

docs: replace convention docs with AGENTS.md rules and ADRs - #977

Merged
albertospelta merged 2 commits into
mainfrom
docs/agent-instructions
Oct 19, 2026
Merged

albertospelta merged 2 commits into
mainfrom
docs/agent-instructions

Conversation

@albertospelta

@albertospelta albertospelta commented Oct 19, 2026 •

Copy link
Copy Markdown
Member
  • .editorconfig declares UTF-8 with BOM for .cs files. Line endings stay with core.autocrlf: the repository stores most .cs files with LF, and declaring crlf would make editors rewrite files checked out with LF.
  • docs/design/code-conventions.md and docs/documentation-guidelines.md are removed. AGENTS.md now states the rule precedence (tool configuration, .NET design guidelines for changed code, no conformance-only changes, contracts with installed clients first) and the documentation layout.
  • Two ADRs record decisions taken for the 1.1.0 release:
    • ADR 0001: releases without update channels; the feed lists stable releases only, with a four-field numeric version.
    • ADR 0002: one UpgradeCode for the per-user and the per-machine MSI, with the Windows Installer behavior that supports it.

No code changes.

Line endings are left to core.autocrlf: the repository stores most .cs files with LF, and declaring crlf would make editors rewrite files checked out with LF.
Remove code-conventions.md and documentation-guidelines.md. AGENTS.md states the rule precedence and the documentation layout. ADR 0001 records releases without update channels, ADR 0002 the shared MSI UpgradeCode.
@albertospelta
albertospelta marked this pull request as ready for review October 19, 2026 18:36
@albertospelta
albertospelta merged commit 4001e39 into main Oct 19, 2026
1 check passed
@albertospelta
albertospelta deleted the docs/agent-instructions branch October 19, 2026 18:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant