Skip to content

Comments

Add CLAUDE.md and consolidate AI agent conventions#352

Open
aram356 wants to merge 11 commits intomainfrom
feature/claude-md-agent-conventions
Open

Add CLAUDE.md and consolidate AI agent conventions#352
aram356 wants to merge 11 commits intomainfrom
feature/claude-md-agent-conventions

Conversation

@aram356
Copy link
Collaborator

@aram356 aram356 commented Feb 20, 2026

Summary

  • Establish CLAUDE.md as the single source of truth so all AI agents (Claude Code, Codex, Cursor) share identical project conventions
  • Add slash commands, subagents, issue templates, and PR template to standardize team workflows
  • Rewrite AGENTS.md as a thin redirect to eliminate duplication and drift

Changes

File Change
CLAUDE.md Rewritten — project overview, workspace layout, toolchain, build commands, coding conventions, error handling, testing, documentation, tracing, git conventions, integration system, JS pipeline, CI gates, workflow, verification, subagents, slash commands, key files, guardrails
AGENTS.md Rewritten — redirects to CLAUDE.md with 8-rule fallback summary for Codex
.agents/ Deleted — all 8 .mdc rule files and mcp.json removed; content inlined into CLAUDE.md
.claude/settings.json New — team-shared permission allowlist organized by category (read, cargo, npm, git)
.claude/commands/ New — 5 slash commands: /check-ci, /test-all, /test-crate, /review-changes, /verify
.claude/agents/ New — 7 subagents: build-validator, code-architect, code-simplifier, verify-app, pr-creator, issue-creator, repo-explorer
.github/ISSUE_TEMPLATE/ New — 3 form-based issue templates: Bug Report, Story, Task (blank issues disabled)
.github/pull_request_template.md New — PR template with summary, changes table, closes section, test plan, checklist
.github/dependabot.yml Normalized YAML quote style
.github/workflows/codeql.yml Normalized YAML quote style and indentation
.gitignore Updated — track .claude/settings.json, .claude/commands/, .claude/agents/ via negation pattern
README.md Fixed clippy command to match CI (--no-deps-- -D warnings)
docs/guide/onboarding.md Updated stale AGENTS.md reference to point to CLAUDE.md
docs/guide/testing.md Fixed clippy command to match CI

Closes

Closes #230

Test plan

  • cargo test --workspace
  • cargo clippy --all-targets --all-features -- -D warnings
  • cargo fmt --all -- --check
  • JS tests: cd crates/js/lib && npx vitest run
  • Other: Verify markdown renders correctly on GitHub, confirm no Rust source code changed (docs/config-only PR)

Checklist

  • Changes follow CLAUDE.md conventions
  • No unwrap() in production code — use expect("should ...")
  • Uses tracing macros (not println!)
  • New code has tests
  • No secrets or credentials committed

@aram356 aram356 self-assigned this Feb 20, 2026
@aram356 aram356 force-pushed the feature/claude-md-agent-conventions branch from e1badb5 to 18085c4 Compare February 20, 2026 22:44
Establish CLAUDE.md as single source of truth for all AI coding agents.
Add slash commands, subagents, issue templates, and PR template to
standardize workflows.
@aram356 aram356 force-pushed the feature/claude-md-agent-conventions branch from 18085c4 to 6c3b5a5 Compare February 20, 2026 22:46
Adapted from edgezero PR #190. Performs deep analysis of changed files,
classifies findings by severity, and submits formal GitHub reviews with
inline comments after user approval.
Audit found 9/14 CLAUDE.md conventions were never used. Removed
rules for #[expect], const fn, impl AsRef, Arc::clone, core>alloc>std,
similar_asserts, insta, and test_ prefix ban. Aligned wildcard import
rule with actual test module usage.
The pr-reviewer agent now checks `gh pr checks` for existing CI
results before falling back to local runs, preventing false "Not run"
reports when GitHub Actions have already completed.
Adopt the emoji conventions from CONTRIBUTING.md:
🔧 for blockers/high (must change), 🤔 for medium (thinking),
⛏ for low (nitpick), 👍 for positive highlights.
Copy link
Collaborator

@ChristianPavilonis ChristianPavilonis left a comment

Choose a reason for hiding this comment

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

Let's include the js and doc format in the flow.

Before creating the PR, verify the branch is healthy:

```
cargo fmt --all -- --check
Copy link
Collaborator

Choose a reason for hiding this comment

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

should include the javascript format for the js crate and docs

1. `cargo fmt --all -- --check`
2. `cargo clippy --all-targets --all-features -- -D warnings`
3. `cargo test --workspace`
4. JS build and test (`cd crates/js/lib && npx vitest run`)
Copy link
Collaborator

Choose a reason for hiding this comment

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

add js format for js and docs format

- [ ] `cargo test --workspace`
- [ ] `cargo clippy --all-targets --all-features -- -D warnings`
- [ ] `cargo fmt --all -- --check`
- [ ] JS tests: `cd crates/js/lib && npx vitest run`
Copy link
Collaborator

Choose a reason for hiding this comment

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

add js and docs format

3. `cargo fmt --all -- --check`
4. `cargo clippy --all-targets --all-features -- -D warnings`
5. `cargo test --workspace`
6. `cd crates/js/lib && npx vitest run`
Copy link
Collaborator

Choose a reason for hiding this comment

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

🔧 docs / js format

1. `cargo fmt --all -- --check`
2. `cargo clippy --all-targets --all-features -- -D warnings`
3. `cargo test --workspace`
4. `cd crates/js/lib && npx vitest run`
Copy link
Collaborator

Choose a reason for hiding this comment

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

🔧 docs and js format

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.

Revise CLAUDE.md per recommendation

2 participants