Skip to content

docs: expand CLAUDE.md with commands and architecture overview#128

Merged
seonghobae merged 1 commit into
masterfrom
claude/claude-md-docs-17yx2e
Jul 11, 2026
Merged

docs: expand CLAUDE.md with commands and architecture overview#128
seonghobae merged 1 commit into
masterfrom
claude/claude-md-docs-17yx2e

Conversation

@seonghobae

Copy link
Copy Markdown
Collaborator

Pull Request

Summary

  • What changed? Expanded CLAUDE.md from a 3-line pointer into a full Claude Code guide, preserving the "AGENTS.md is canonical" convention at the top. It now documents real, repo-derived commands (rcmdcheck full check with R_PROFILE_USER=/dev/null, testthat::test_local() for the edition-3 suite and single-file runs via filter, roxygen2::roxygenise() for man/NAMESPACE, and the exact yamllint/markdownlint CI invocations), plus an architecture section covering autoFIPC()/surveyFA(), the Kim (2006) fixed-anchor linking contract, the packrat opt-in, and key guardrails summarized from AGENTS.md/CONTRIBUTING.md (numerical-behavior preservation, formula-pinning tests, trivy-fs remediation policy, no copyleft deps, SHA-pinned Actions).
  • Why is this needed? So AI coding assistants get accurate commands and architecture context up front, instead of rediscovering them per session.

Validation

  • R CMD check (or equivalent CI) succeeded — not run locally; documentation-only change, no R code touched
  • Markdown/YAML/workflow lint checks succeeded — verified with the exact CI linter version (markdownlint-cli2@0.18.1, 0 errors); a markdownlint-configure-file comment raises MD013 to 120 for this file since the required intro sentence is 102 chars
  • No secrets or credentials were added

Risk and Rollback

  • Risk level: low (documentation-only; no code, workflow, or dependency changes)
  • Rollback plan: revert this single commit

Behavioral Impact

  • R/aFIPC.R unchanged
  • If changed, regression evidence is attached — N/A

Checklist

  • Docs updated (README.md, ARCHITECTURE.md, CONTRIBUTING.md) as needed — none required changes; this PR only expands CLAUDE.md
  • New/updated GitHub Actions use full commit SHA pinning — N/A (no workflow changes)
  • Security policy / contribution policy alignment verified — content summarizes existing AGENTS.md/CONTRIBUTING.md policy without altering it

🤖 Generated with Claude Code

https://claude.ai/code/session_019zWjgFjCupJNvARzcFETtR


Generated by Claude Code

@opencode-agent

opencode-agent Bot commented Jul 11, 2026

Copy link
Copy Markdown
Contributor

OpenCode Review Overview

  • Head SHA: 2d2fddd830818ab53f9338a949d9926ee66db7a1
  • Workflow run: 29140125460
  • Workflow attempt: 1
  • Gate result: APPROVE (approval step)

Pull request overview

OpenCode reviewed the current-head bounded evidence and found no blocking issues.

Findings

No blocking findings.

Summary

Approval sufficiency: bounded evidence supplied affirmative approval evidence for changed files, coverage/docstring posture, risk surfaces, and current-head verification; approval is not based merely on the absence of known blockers.
Verification posture: CodeGraph evidence was initialized and bounded current-head evidence reviewed for changed-file evidence including CLAUDE.md.
Linter/static: workflow/static review evidence is bounded by the current-head GitHub Checks gate and changed-file evidence.
TDD/regression: coverage execution evidence and focused changed hunks were reviewed from bounded-review-evidence.md.
Coverage: coverage execution evidence reports test coverage as not applicable because no supported changed source files or package manifests were found.
Docstring coverage: coverage execution evidence reports docstring coverage as not applicable because no supported changed source files or package manifests were found.
DAG: CodeGraph/source-backed behavior map connects CLAUDE.md to the affected review, runtime, or workflow path and required checks.
PoC/execution: coverage-evidence job executed on the current head and reported PASS.
DDD/domain: workflow and repository-governance invariants were reviewed against changed files in bounded evidence.
CDD/context: CodeGraph evidence, changed-file history, and focused hunks were reviewed from bounded-review-evidence.md.
Similar issues: changed-file history evidence was reviewed for comparable local precedents.
Claim/concept check: bounded evidence, repository source, current-head workflow evidence, and, where numeric, scientific, statistical, or literature-backed claims are affected, original-paper/formula evidence and parameter-recovery expectations were used for claims.
Standards search: standards and external-source checks are delegated to configured OpenCode web_search/Context7/DeepWiki sources when applicable; no evidence-backed standards blocker is present in bounded evidence.
Compatibility/convention: changed workflow/script conventions, object naming, and reserved-word safety for schema/API/config/code surfaces were checked in bounded evidence.
Breaking-change/backcompat: deployment evidence and changed-file history were checked for backward-compatibility risk.
Performance: changed surfaces were checked for performance risk in bounded evidence.
Developer experience: changed automation, review, test, setup, and maintenance surfaces were checked for helpful or obstructive DX impact in bounded evidence.
User experience: connected user, operator, API, CLI, documentation, review-comment, status-check, rendering, and workflow-reader behavior was checked for contradictions against code, docs, and tests in bounded evidence.
Visual/DOM: Playwright visual, DOM locator, ARIA snapshot, console, and responsive evidence were checked when a web UI surface was present; for non-web surfaces, API/CLI/log/docs/workflow interaction evidence was reviewed instead.
Accessibility/i18n: accessibility, localization, and human-readable text surfaces were checked where UI, CLI, API message, docs, logs, or review text changed.
Supply-chain/license: dependency, package, model, container, and external-tool changes were checked in bounded evidence.
Packaging: package, build, test, lint, and security contracts were checked in bounded evidence.
Security/privacy: workflow-token, review-gate, and repository-automation security/privacy boundaries were checked in bounded evidence.

  • Result: APPROVE
  • Reason: Documentation improvement with no code changes
  • Head SHA: 2d2fddd830818ab53f9338a949d9926ee66db7a1
  • Workflow run: 29140125460
  • Workflow attempt: 1

Changed-File Evidence Map

flowchart LR
  PR["PR changed files"] --> Evidence["OpenCode bounded evidence"]
  Evidence --> S1["Changed file: CLAUDE.md"]
  S1 --> I1["repository behavior"]
  I1 --> R1["Review risk: Changed file: CLAUDE.md"]
  R1 --> V1["required checks"]
Loading

@opencode-agent opencode-agent Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

OpenCode reviewed the current-head bounded evidence and found no blocking issues.

Findings

No blocking findings.

Summary

Approval sufficiency: bounded evidence supplied affirmative approval evidence for changed files, coverage/docstring posture, risk surfaces, and current-head verification; approval is not based merely on the absence of known blockers.
Verification posture: CodeGraph evidence was initialized and bounded current-head evidence reviewed for changed-file evidence including CLAUDE.md.
Linter/static: workflow/static review evidence is bounded by the current-head GitHub Checks gate and changed-file evidence.
TDD/regression: coverage execution evidence and focused changed hunks were reviewed from bounded-review-evidence.md.
Coverage: coverage execution evidence reports test coverage as not applicable because no supported changed source files or package manifests were found.
Docstring coverage: coverage execution evidence reports docstring coverage as not applicable because no supported changed source files or package manifests were found.
DAG: CodeGraph/source-backed behavior map connects CLAUDE.md to the affected review, runtime, or workflow path and required checks.
PoC/execution: coverage-evidence job executed on the current head and reported PASS.
DDD/domain: workflow and repository-governance invariants were reviewed against changed files in bounded evidence.
CDD/context: CodeGraph evidence, changed-file history, and focused hunks were reviewed from bounded-review-evidence.md.
Similar issues: changed-file history evidence was reviewed for comparable local precedents.
Claim/concept check: bounded evidence, repository source, current-head workflow evidence, and, where numeric, scientific, statistical, or literature-backed claims are affected, original-paper/formula evidence and parameter-recovery expectations were used for claims.
Standards search: standards and external-source checks are delegated to configured OpenCode web_search/Context7/DeepWiki sources when applicable; no evidence-backed standards blocker is present in bounded evidence.
Compatibility/convention: changed workflow/script conventions, object naming, and reserved-word safety for schema/API/config/code surfaces were checked in bounded evidence.
Breaking-change/backcompat: deployment evidence and changed-file history were checked for backward-compatibility risk.
Performance: changed surfaces were checked for performance risk in bounded evidence.
Developer experience: changed automation, review, test, setup, and maintenance surfaces were checked for helpful or obstructive DX impact in bounded evidence.
User experience: connected user, operator, API, CLI, documentation, review-comment, status-check, rendering, and workflow-reader behavior was checked for contradictions against code, docs, and tests in bounded evidence.
Visual/DOM: Playwright visual, DOM locator, ARIA snapshot, console, and responsive evidence were checked when a web UI surface was present; for non-web surfaces, API/CLI/log/docs/workflow interaction evidence was reviewed instead.
Accessibility/i18n: accessibility, localization, and human-readable text surfaces were checked where UI, CLI, API message, docs, logs, or review text changed.
Supply-chain/license: dependency, package, model, container, and external-tool changes were checked in bounded evidence.
Packaging: package, build, test, lint, and security contracts were checked in bounded evidence.
Security/privacy: workflow-token, review-gate, and repository-automation security/privacy boundaries were checked in bounded evidence.

  • Result: APPROVE
  • Reason: Documentation improvement with no code changes
  • Head SHA: 2d2fddd830818ab53f9338a949d9926ee66db7a1
  • Workflow run: 29140125460
  • Workflow attempt: 1

Changed-File Evidence Map

flowchart LR
  PR["PR changed files"] --> Evidence["OpenCode bounded evidence"]
  Evidence --> S1["Changed file: CLAUDE.md"]
  S1 --> I1["repository behavior"]
  I1 --> R1["Review risk: Changed file: CLAUDE.md"]
  R1 --> V1["required checks"]
Loading

@seonghobae seonghobae merged commit 1bbaee2 into master Jul 11, 2026
23 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.

2 participants