Skip to content

Add CLAUDE.md project guidance file#186

Open
afinetooth wants to merge 1 commit into
masterfrom
add-claude-md-guidance
Open

Add CLAUDE.md project guidance file#186
afinetooth wants to merge 1 commit into
masterfrom
add-claude-md-guidance

Conversation

@afinetooth
Copy link
Copy Markdown
Member

Summary

Adds CLAUDE.md — a project-level guidance file for Claude Code (and other AI coding agents) to navigate this repo. Content mirrors what's already in README.md and doc/development.md, organized for fast on-boarding:

  • Project overview
  • Development commands (shards install, make build, make test, etc.)
  • Testing conventions (Spectator, fixtures, ENV mocking)
  • Architecture (core flow, configuration hierarchy, parser system, CI detection system)
  • Procedures for adding new coverage formats / CI support
  • Build system and release process notes
  • Index of important files

Nothing operationally new. Nothing sensitive. Useful for AI-assisted contributions and onboarding.

Test plan

  • CI passes (no functional changes; documentation-only addition).

🤖 Generated with Claude Code

Provides Claude Code (and other AI agents) with a fast-onboarding map of
the repo: project overview, dev commands, testing conventions, architecture,
parser/CI extension procedures, and build/release process. Mirrors content
already in README.md and doc/development.md, organized for agent use.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@codacy-production
Copy link
Copy Markdown

Not up to standards ⛔

🔴 Issues 12 minor

Alerts:
⚠ 12 issues (≤ 0 issues of at least minor severity)

Results:
12 new issues

Category Results
BestPractice 1 minor
CodeStyle 11 minor

View in Codacy

NEW Get contextual insights on your PRs based on Codacy's metrics, along with PR and Jira context, without leaving GitHub. Enable AI reviewer
TIP This summary will be updated as you push new changes.

@coveralls-official
Copy link
Copy Markdown

Coverage Report for CI Build 25443983655

Coverage remained the same at 94.07%

Details

  • Coverage remained the same as the base build.
  • Patch coverage: No coverable lines changed in this PR.
  • No coverage regressions found.

Uncovered Changes

No uncovered changes found.

Coverage Regressions

No coverage regressions found.


Coverage Stats

Coverage Status
Relevant Lines: 995
Covered Lines: 936
Line Coverage: 94.07%
Coverage Strength: 2.14 hits per line

💛 - Coveralls

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