Skip to content

Unify agent instructions into AGENTS.md (CLAUDE.md symlink) - #8261

Merged
Aaronontheweb merged 1 commit into
akkadotnet:devfrom
Aaronontheweb:docs/unify-agents-md
Jun 12, 2026
Merged

Aaronontheweb merged 1 commit into
akkadotnet:devfrom
Aaronontheweb:docs/unify-agents-md

Conversation

@Aaronontheweb

Copy link
Copy Markdown
Member

Summary

Consolidates the repo's two agent-instruction files into a single source of truth.

  • AGENTS.md (new, canonical) — the cross-tool standard filename. Contains the merged union of the former CLAUDE.md and AGENT.md, de-duplicated and reconciled.
  • CLAUDE.md → now a symlink to AGENTS.md, so both names resolve to the same guidance.
  • AGENT.md (non-standard singular) — removed; its unique content is folded into AGENTS.md.

Content folded in from the old AGENT.md

  • Git repository management (remotes, upstream sync, feature-branch workflow)
  • API approvals (approval-file paths, diff-viewer tooling, the [Obsolete("Obsolete since v{current-akka-version}")] convention)
  • Detailed TestKit guidance (ITestOutputHelper wiring, EventFilter/dead-letter assertions, TestProbe, cleanup) — reconciled to the async-only TestKit rule (sync ExpectMsg/ExpectNoMsg references updated to their async forms)
  • Repository conventions (keep PRs small, fix warnings vs. suppress, treat TBD as action items, benchmark perf-critical changes, no new deps without a license/security check)

The v1.6 breaking-change tracking rule (added in #8260) is preserved.

Note on the symlink

CLAUDE.md is committed as a git symlink (mode 120000). On Linux/macOS it resolves transparently. On default Git-for-Windows (core.symlinks=false) it materializes as a small text stub containing AGENTS.md; the real content always lives in AGENTS.md. Chosen direction keeps AGENTS.md (the standard) as the real file.

Docs/process only — no source or test impact.

Merges the contents of AGENT.md and CLAUDE.md into a single canonical
AGENTS.md (the cross-tool standard filename), and makes CLAUDE.md a
symlink to it so both names resolve to the same guidance. Folds in the
unique sections that previously lived only in AGENT.md (Git workflow,
API approvals, detailed TestKit guidance, repository conventions) and
reconciles the TestKit guidance to the async-only rule. Removes the
non-standard singular AGENT.md.
@Aaronontheweb
Aaronontheweb enabled auto-merge (squash) June 12, 2026 20:41
@Aaronontheweb
Aaronontheweb disabled auto-merge June 12, 2026 20:43
@Aaronontheweb
Aaronontheweb merged commit 5c7485e into akkadotnet:dev Jun 12, 2026
4 of 10 checks passed
@Aaronontheweb
Aaronontheweb deleted the docs/unify-agents-md branch June 12, 2026 20:43
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