Skip to content

docs: add CLAUDE.md guidance for AI assistants#13

Merged
seonghobae merged 2 commits into
mainfrom
claude/claude-md-docs-17yx2e
Jul 12, 2026
Merged

docs: add CLAUDE.md guidance for AI assistants#13
seonghobae merged 2 commits into
mainfrom
claude/claude-md-docs-17yx2e

Conversation

@seonghobae

Copy link
Copy Markdown
Contributor

Summary

Adds a CLAUDE.md at the repo root that points to AGENTS.md as the canonical agent guide (Security Scan gate, secrets-via-Env rule) and complements it with:

  • Commands: wrangler dev/deploy, vitest including single-test invocation, typecheck, security scan, release:verify, and the KPI/readiness audit tooling. Notes explicitly that no lint script exists in package.json rather than inventing one.
  • Architecture: the single-file Cloudflare Worker (src/index.ts) with its /health and /exchange routes, the OIDC-to-installation-token exchange flow, the contract-tested response envelope and headers, the structured http_request log schema feeding the KPI pipeline, in-isolate caches, and wrangler.toml vars/secrets (no KV/D1/queue bindings).
  • Conventions: Unreleased-section changelog updates, mixed Korean/English docs, fail-closed posture.

🤖 Generated with Claude Code

https://claude.ai/code/session_019zWjgFjCupJNvARzcFETtR


Generated by Claude Code

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_019zWjgFjCupJNvARzcFETtR
@github-advanced-security

Copy link
Copy Markdown

You are seeing this message because GitHub Code Scanning has recently been set up for this repository, or this pull request contains the workflow file for the Code Scanning tool.

What Enabling Code Scanning Means:

  • The 'Security' tab will display more code scanning analysis results (e.g., for the default branch).
  • Depending on your configuration and choice of analysis tool, future pull requests will be annotated with code scanning analysis results.
  • You will be able to see the analysis results for the pull request's branch on this overview once the scans have completed and the checks have passed.

For more information about GitHub Code Scanning, check out the documentation.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds a new CLAUDE.md document to guide Claude Code usage in this repo, explicitly deferring to AGENTS.md as the canonical cross-agent guardrail source (Security Scan gate expectations and secrets-via-Worker-Env rule).

Changes:

  • Introduces CLAUDE.md with required-first-read guidance pointing to AGENTS.md.
  • Documents the repo’s core commands (dev/deploy/test/typecheck/security/release verification) and CI/CD entry points.
  • Summarizes the Worker’s architecture/contracts (/health, /exchange, response envelope/headers, logging schema, in-isolate caches, bindings).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@seonghobae
seonghobae merged commit d4995e7 into main Jul 12, 2026
13 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.

4 participants