Skip to content

docs: adopt agent decision comments - #37

Merged
dbrattli merged 1 commit into
mainfrom
agent/adopt-agent-decision-comments
Aug 11, 2026
Merged

docs: adopt agent decision comments#37
dbrattli merged 1 commit into
mainfrom
agent/adopt-agent-decision-comments

Conversation

@dbrattli

Copy link
Copy Markdown
Collaborator

Summary

  • adopt Agent Decision Comments specification 0.1.0 in AGENTS.md
  • make CLAUDE.md defer to the repository-wide agent instructions
  • add focused decision:, invariant:, assumption:, and tradeoff: comments to the public API and core runtime
  • document cross-target test/build constraints and representative interop and UI boundaries

Why

Fable.Actor has several non-obvious portability and lifecycle choices that are difficult to recover from types and tests alone. Keeping concise rationale beside the governed code helps reviewers and future coding agents preserve those constraints.

Impact

This is a documentation-only change. It does not alter runtime behavior or public signatures.

Validation

  • just format
  • just check
  • 28/28 tests on .NET
  • 28/28 tests on Python
  • 28/28 tests on JavaScript
  • 28/28 tests on BEAM
  • git diff --check

@dbrattli
dbrattli marked this pull request as ready for review August 11, 2026 19:14
@dbrattli
dbrattli merged commit 266ba69 into main Aug 11, 2026
2 checks passed
@dbrattli
dbrattli deleted the agent/adopt-agent-decision-comments branch August 11, 2026 20:39
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