Skip to content

docs: expand agent instructions and enforce module layering - #467

Merged
doron050 merged 2 commits into
mainfrom
docs/agent-instructions
Oct 24, 2026
Merged

doron050 merged 2 commits into
mainfrom
docs/agent-instructions

Conversation

@doron050

Copy link
Copy Markdown
Collaborator

Summary

  • Rewrites AGENTS.md to cover:
    • which code goes where, the project dependency graph and the contracts between layers
    • every generated or derived file, with its source of truth
    • non-obvious behaviours ("outliers") that aren't visible from the design
    • step-by-step recipes for options, annotations, drivers and new types
    • known issues and existing layering violations not to copy
  • Fixes inaccuracies in the old AGENTS.md: the code samples, the MySQL :execlastid description, and the options and labels lists.
  • Adds nested instructions: Drivers/AGENTS.md (driver extension points, type mappings, nullability, per-database notes), end2end/AGENTS.md (test scaffolding, how test schemas load) and docs/AGENTS.md (README is generated by the release flow).
  • Fixes docs/05_MySql.md: :execlastid appends ; SELECT LAST_INSERT_ID() in both driver and Dapper modes, not LastInsertedId.
  • Adds unit-tests/RepositoryTests/ArchitectureTests.cs:
    • checks the exact plugin project reference graph
    • checks that CodeGenerator/ (except InstantiateDriver) and Drivers/Generators/ don't reference concrete drivers

Generated output is unchanged; nothing under examples/ is affected.

Testing

  • The local machine has no .NET 10 SDK. I compiled a standalone copy of ArchitectureTests on .NET 9 and ran it against the repo: 10/10 passed. With a broken reference and a forbidden file allowed on purpose, the 2 matching cases failed as expected.
  • CI (dotnet test RepositoryTests) is the first full run on .NET 10.

Checklist

  • Generated code is regenerated: not applicable, no codegen changes
  • Tests added or updated
  • skip-release label set

🤖 Generated with Claude Code

- Rewrite AGENTS.md: module ownership map, layer contracts, generated
  artifacts table, outliers, change recipes, known issues; fix wrong
  code samples and MySQL :execlastid description
- Add nested AGENTS.md for Drivers/, end2end/ and docs/
- Fix docs/05_MySql.md :execlastid section (LAST_INSERT_ID is appended
  in both driver and Dapper modes)
- Add ArchitectureTests enforcing the project reference graph and that
  CodeGenerator / Drivers/Generators do not use concrete drivers

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@doron050 doron050 added the skip-release Exclude this pull request from the next release changelog. label Oct 24, 2026
@github-actions

Copy link
Copy Markdown
Contributor

Release Assistant - Passed

PR marked as skip-release. No release will be triggered.

1 similar comment
@github-actions

Copy link
Copy Markdown
Contributor

Release Assistant - Passed

PR marked as skip-release. No release will be triggered.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@doron050
doron050 merged commit cbd0f95 into main Oct 24, 2026
12 checks passed
@doron050
doron050 deleted the docs/agent-instructions branch October 24, 2026 15:15
@github-actions github-actions Bot mentioned this pull request Oct 24, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

skip-release Exclude this pull request from the next release changelog.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant