Skip to content

Add CLAUDE.md with repo rundown and rules of engagement#9

Merged
PeterSR merged 1 commit into
mainfrom
docs-version-bump-reminder
Jun 8, 2026
Merged

Add CLAUDE.md with repo rundown and rules of engagement#9
PeterSR merged 1 commit into
mainfrom
docs-version-bump-reminder

Conversation

@PeterSR

@PeterSR PeterSR commented Jun 8, 2026

Copy link
Copy Markdown
Owner

Adds a repo-root CLAUDE.md orienting agents and contributors to the project and codifying the rules of engagement.

Covers:

  • What spiffile is — a files profile for SPIFFE plus three interchangeable implementations; PROFILE.md is the spec.
  • Repository layout and the one-runtime-dependency-max constraint.
  • The parity contract — behaviour changes land in all three implementations (+ conformance fixtures when validity changes) in one PR; run the check-parity skill after touching an implementation, PROFILE.md, or conformance/. Lists the constants that must stay identical.
  • Build/test/lint commands per language and the cross-mint matrix.
  • Profile changes — issue-first.
  • Versioning & releases — bump the version in the same PR that changes a library's surface; the full set of files a bump touches; the tag-driven publish flow.
  • Working conventions — branch + PR (no direct pushes to main), commit-subject style, security/no-secrets.

This supersedes the earlier minimal version-bump-only draft on this branch.

@PeterSR PeterSR force-pushed the docs-version-bump-reminder branch from d5465ff to 25be0f9 Compare June 8, 2026 15:21
@PeterSR PeterSR changed the title Add CLAUDE.md with a release/version-bump checklist Add CLAUDE.md with repo rundown and rules of engagement Jun 8, 2026
Document the project for agents and contributors: what spiffile is, the
repository layout, the parity contract (behaviour changes land in all three
implementations plus conformance in one PR), per-language build/test/lint
commands, the issue-first profile-change rule, the cross-language
version-bump and tag-driven release workflow, and working conventions.
@PeterSR PeterSR force-pushed the docs-version-bump-reminder branch from 25be0f9 to bb1796e Compare June 8, 2026 15:26
@PeterSR PeterSR merged commit 1f50209 into main Jun 8, 2026
4 checks passed
@PeterSR PeterSR deleted the docs-version-bump-reminder branch June 8, 2026 17:20
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