Skip to content

docs: track CLAUDE.md instructions in the repo - #69

Merged
juemerson-at-purestorage merged 2 commits into
dmann000:mainfrom
juemerson-at-purestorage:docs/track-claude-md-files
Aug 13, 2026
Merged

docs: track CLAUDE.md instructions in the repo#69
juemerson-at-purestorage merged 2 commits into
dmann000:mainfrom
juemerson-at-purestorage:docs/track-claude-md-files

Conversation

@juemerson-at-purestorage

Copy link
Copy Markdown
Collaborator

Summary

CLAUDE.md (repo root), .github/workflows/CLAUDE.md, and Tests/CLAUDE.md
existed only in local working trees -- never committed on any branch, despite
the root file describing itself as repo-committed guidance safe to publish.
This adds all three to version control so they're actually visible to
collaborators.

Also adds one new section to the root file: regenerate Reports/ drift-report
artifacts in the same commit whenever cmdlet parameter/endpoint coverage
changes, and merge/rebase onto current main first (to avoid mixing in an
unrelated spec-version bump) -- a real gap found finishing PR #51 this session.

No code changes.

Test plan

  • Docs-only change, no functional/test impact

These three files (repo root, .github/workflows/, Tests/) existed only in
local working trees -- never committed on any branch, despite the root file
describing itself as repo-committed guidance safe to publish. Adds them to
version control so they're actually visible to collaborators, plus a new
root-level section on regenerating Reports/ drift-report artifacts whenever
a commit changes cmdlet parameter/endpoint coverage (learned the hard way
finishing PR dmann000#51 this session).
The original three files were written before the issue-dmann000#63 CI work landed, so
they described a repo whose test entry point and gates no longer match. Nothing
in them was wrong; they were silent about the parts most likely to red a build.

Tests/CLAUDE.md gains the CI entry point, with the correction that -Edition
selects which coverage baseline to measure against rather than which
interpreter runs -- so each edition needs its own host. Also the coverage gate
(MaxSkipped as a ceiling with headroom, RequiredDescribes for blocks that skip
gracefully and so contribute neither a pass nor a skip), why the two editions
differ by design, the gitignored tools/specs cache the tooling tests depend on,
and the -Confirm:$false requirement for ConfirmImpact=High cmdlets.

.github/workflows/CLAUDE.md gains the merge-commit semantics of pull_request
runs: a green run goes stale when main moves with no branch change, and a
manual re-run replays the recorded SHA rather than re-measuring, so it cannot
clear a stale result.

CLAUDE.md gains a before-you-push section pointing at both, and the standing
rule that version bumps and CHANGELOG edits are a separate maintainer decision
rather than part of a feature PR.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@juemerson-at-purestorage

Copy link
Copy Markdown
Collaborator Author

Rebased onto current main (93f0ffd) and updated. The original commit was authored 116 commits back, before the issue-#63 CI work landed, so the files described a repo whose test entry point and gates no longer matched. Nothing in them was wrong — they were silent about the parts most likely to red a build.

Added, in a second commit so the rebase and the new content stay separable:

Tests/CLAUDE.md

  • The CI entry point, with the correction that -Edition selects which coverage baseline to measure against rather than which interpreter runs — so each edition needs its own host, and -Edition winps51 from pwsh 7 measures a 7 run against the 5.1 ceiling.
  • The coverage gate: MaxSkipped as a ceiling with headroom rather than a pin, and RequiredDescribes for blocks that skip gracefully and so contribute neither a pass nor a skip — which a skip ceiling cannot see disappear.
  • Why the two editions differ by ~190 skips by design, the gitignored tools/specs cache the tooling tests depend on, and -Confirm:$false for ConfirmImpact = 'High' cmdlets under -NonInteractive.

.github/workflows/CLAUDE.md

CLAUDE.md

  • A before-you-push section pointing at both, and the standing rule that version bumps and CHANGELOG.md edits are a separate maintainer decision rather than part of a feature PR.

Still additive only — no existing file is modified, since none of these three exist on main.

@juemerson-at-purestorage
juemerson-at-purestorage merged commit e2d292e into dmann000:main Aug 13, 2026
5 checks passed
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