docs(testing): server test-writing guide + de-ghosted spec citations (#571) - #721
Merged
Conversation
…571) A contributor stepped down from #571 for lack of business-logic context. Root causes fixed: - NEW docs/developer/SERVER_TESTING.md: exemplar tests to copy from, the TestPaths/ContentLoader/TestLocales fixtures, an "invariants, not mirrored constants" table per target kind, determinism rules (libm trig gotcha) and the CI analyzer traps. Linked from CONTRIBUTING, AGENTS and the docs index. - AGENTS.md: document that `anf_*.md` citations are internal pre-open- sourcing German design specs not in the public repo — the doc-comment summary is the public authority. - Self-contained behaviour summaries where citations carried the weight: MissionValidator (full rule list), ServerPresets (lookup contract), FrequencyExtensions (consumers + invariants, OreFactor Off exception). Comment/docs-only; no behaviour change. 1398 fast-tier tests green, clean rebuild 0 warnings, dotnet format clean. Co-Authored-By: Claude Fable 5 <[email protected]>
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
1 participant
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.
Why
@salem-wdev stepped down from #571 with "I don''t have enough context regarding the underlying business logic to write effective and meaningful tests." Root-cause analysis found three documentation gaps this PR closes — thanks Salem for surfacing them!
What
TestPaths.DataDir()+ContentLoader,TestLocales), an "assert invariants, not mirrored constants" table per target kind, determinism rules (incl. the Win/Linux libm trig gotcha) and the CI analyzer traps. Linked from CONTRIBUTING.md, AGENTS.md and the docs index.anf_*.mdcitations de-ghosted — 26 source files cite internal German design specs that are gitignored, so fork contributors chase references into the void. AGENTS.md now states the convention: the English doc-comment summary is the public authority; a citation without a summary is a doc bug.MissionValidator(full rule list),ServerPresets(lookup contract),FrequencyExtensions(consumers + invariants, incl. theOreFactorOff≠0 exception).Verification
Comment/docs-only, no behaviour change. Clean rebuild 0 warnings / 0 errors,
dotnet formatclean, fast-tier suite 1398/1398 green.🤖 Generated with Claude Code