Rewrite AGENTS.md as an architecture guide and add CLAUDE.md - #401
Draft
jasonleenaylor wants to merge 1 commit into
Draft
Rewrite AGENTS.md as an architecture guide and add CLAUDE.md#401jasonleenaylor wants to merge 1 commit into
jasonleenaylor wants to merge 1 commit into
Conversation
Replaces the onboarding log with guidance an agent can act on. The old file recorded that dotnet build and dotnet test had FAILED and attributed both to GitVersion, which sent readers down a dead end; it also inventoried the repo root and top-level directories, which the repository already states. What the file now carries that could not be discovered cheaply: - Editing a Generated*.cs file does not fail. Regeneration is skipped while the file is newer than MasterLCModel.xml, so the edit compiles locally and the tests pass while CI builds different code from the XML. The files are gitignored, so it can never be committed. A fresh worktree has none of them until the first build, and a stale one left by a branch switch is compiled as it stands. - Per-rule consequences instead of one blanket claim, since rule 1 neither breaks the build nor corrupts data. - The FLEx Bridge metadata cache obligation from WARNING 4. - Worktrees need a named branch, because GitVersion cannot version a detached HEAD, and removal needs the directory left first. - ParallelizeAssembly=false is required because ICU and the writing system subsystems hold shared state. - Windows builds need the C++ tools whether or not the IDE is used, because code generation preprocesses the IDL with cl.exe. Corrects the IOC description: the container is Microsoft.Extensions.DependencyInjection since #393, not StructureMap. Drops the transcribed SDK version, target frameworks and CI command list in favour of pointing at global.json, the csproj files and ci-cd.yml, which is where they are actually defined. The -m:1 rule and the instruction to report failing instructions are carried forward unchanged. CLAUDE.md imports AGENTS.md and points Claude-only procedures at .claude/skills/, matching FieldWorks and interlinearizer-extension. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Rewrites
AGENTS.mdas an architecture guide and addsCLAUDE.md.Stacked on #400, which is stacked on #364. Review those first; this PR targets #400's branch.
Why rewrite rather than amend
The old file was an onboarding log. It recorded that
dotnet buildanddotnet testhadFAILED and attributed both to GitVersion, which is a dead end for anyone who reads it — the
real causes are a detached-HEAD worktree and a race in the code generation targets. It also
inventoried the repository root and top-level directories, which the repository already
states, and transcribed the SDK version and CI command sequence, which drifted from
global.jsonandci-cd.yml.What the file now carries that cannot be discovered cheaply
Generated*.csfile does not fail. Regeneration is skipped while the file isnewer than
MasterLCModel.xml, so the edit compiles into the local build and the testspass, while CI generates from the XML into a fresh tree and builds different code. The files
are gitignored, so the edit can never be committed. A fresh clone or worktree has none of
them until the first build, and a stale one left by a branch switch is compiled as it stands.
rule 4 breaks the build; rule 1 does neither, which is what makes it dangerous.
WARNING 4.needs the directory left first, since build output is untracked.
-p:ParallelizeAssembly=falseis not optional: ICU and the writing system subsystemshold shared state.
generation preprocesses the IDL with
cl.exe, located viavswhere..csfile from another branch produceserrors that look like your change broke something.
Corrections
The IOC section described StructureMap. Since #393 the container is
Microsoft.Extensions.DependencyInjection, wrapped inMicrosoftServiceLocatorsoGetInstance<T>()still works.Facts now pointed at rather than copied
The SDK floor, target frameworks and CI sequence point at
global.json, the.csprojfilesand
.github/workflows/ci-cd.yml. The transcriptions are what went stale; the definitionscannot.
The
-m:1rule from #364 and the instruction to report failing instructions are carriedforward unchanged.
Checked against source
The flid arithmetic (
LexSenseTags.kflidDefinitionis5016005),LexDbatomic underLangProject,Stylesas anStStylecollection, all sevenOverrides*.csnames, the ninegenerated files,
CheckWinFormsin three projects, and every path in the layout tree.CLAUDE.mdimportsAGENTS.mdand points Claude-only procedures at.claude/skills/,matching FieldWorks and interlinearizer-extension.
Docs only, so no build or test run is claimed.
This change is