Repository navigation
docs: consolidate Unified Diagnostics and GH naming standards - #205
Merged
michaldengusiak merged 2 commits intoOct 16, 2026
Merged
Conversation
Add docs/DIAGNOSTICS_STANDARD.md, extend GH_COMPONENT_STANDARDS.md (triggers, Name vs NickName, new-vs-legacy quick reference, corrected status), link both from AGENTS.md. Documentation only. [skip ci] Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
…-component naming Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
michaldengusiak
marked this pull request as ready for review
October 16, 2026 09:52
michaldengusiak
added a commit
that referenced
this pull request
Oct 16, 2026
…kip ci] Co-Authored-By: Claude Sonnet 5.5 <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.
Documentation only. No source, test, build, Grasshopper contract or numerical change.
Existing guidance discovered
docs/GH_COMPONENT_STANDARDS.md(docs(gh): canonical SAM-BIM Grasshopper component engineering standard #204) plus Psychrometrics pilot records. Not duplicated.Created / consolidated
docs/DIAGNOSTICS_STANDARD.md(API as implemented, severity/detail semantics, producer-owned severity, Warnings/Errors survive filtering, detail never affects engineering results, lazy messages, three adapter architectures, legacy compatibility, testing rules).docs/GH_COMPONENT_STANDARDS.md: GH-B7 execution triggers (_run/run_/_run_, counts from source), GH-I3a Name vs NickName, section K new-vs-legacy quick reference, section E now links the Diagnostics standard.documentation/Unified-Engineering-Standards-Q4.md.How agents find them
New mandatory "Engineering standards" section in
AGENTS.mdlinking both.Duplicate / outdated guidance
PROJECT_PROGRESS.mdhas no SAM cross-reference for Phases 3/4A/4B. AGENTS.md forbids editing it on a PR branch, so deferred to the post-merge closeout; the standard's appendix lists PRs and merge SHAs meanwhile.Rollout recommendations (separate PRs, not done)
Add the same AGENTS.md pointer in SAM_OCCT, SAM_OpenStudio, SAM_Tas, SAM_Tas_Grasshopper, SAM_Psychrometrics. Open owner decisions left open:
_diagnosticDetail_spelling (GH-E3); wiring TAS adapters into TAS components.Validation
Checked against
SAM.Coresource and Grasshopper component source; Markdown links verified; diff is docs + AGENTS.md only. Python validator tests not run (no Python here; unaffected).🤖 Generated with Claude Code