Skip to content

Commit 66eddbd

Browse files
committed
update docs
1 parent b8e10d0 commit 66eddbd

1 file changed

Lines changed: 44 additions & 24 deletions

File tree

AGENTS.md

Lines changed: 44 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,19 @@ The ONLY reason you should stop is if you have a blocking question for the user.
88

99
Smart case-aware search and replace across code and files with atomic apply and undo.
1010

11+
## CRITICAL: Context-Specific CLAUDE.md Files
12+
13+
This repository contains multiple CLAUDE.md files throughout the codebase, each providing context-specific instructions for different parts of the project:
14+
15+
- **Root `/CLAUDE.md`** (this file) - Overall project architecture, workflows, and standards
16+
- **`/renamify-mcp/CLAUDE.md`** - MCP server specific rules (Ultracite coding standards)
17+
- **`/renamify-vscode/CLAUDE.md`** - VS Code extension specific rules and patterns
18+
- **Other subdirectories may have their own CLAUDE.md files**
19+
20+
**You MUST read the context-specific CLAUDE.md file whenever working in that part of the codebase.** These files contain critical rules and patterns specific to that component. For example, the MCP server has strict TypeScript/accessibility rules enforced by Ultracite that don't apply to Rust code.
21+
22+
**Note:** `/renamify-e2e-test/` is a temporary directory created during e2e tests (a clone of the entire repo for testing self-renaming). It's not part of the source tree and should be ignored.
23+
1124
## Project background
1225

1326
- Greenfield, unreleased. No backwards compatibility. Delete and tidy old code immediately.
@@ -210,12 +223,17 @@ The unrestricted levels (`-u` flag) control ignore behavior:
210223

211224
1. Begin next task and keep going
212225
- Implement tasks in order unless dependencies dictate otherwise
213-
2. After each task
214-
- Run tests and linters
226+
2. After each task - BEFORE marking as complete:
227+
- Run `task ci` - this runs all linters, formatters, and tests that run on CI
228+
- Run `coderabbit --plain` - get third-party code review
229+
- Implement ALL suggestions from CodeRabbit
230+
- Repeat `task ci` and `coderabbit --plain` until BOTH pass with no issues or suggestions
215231
- Update docs if anything changed
216232
- Commit with a clear message
217233
3. Only pause for a blocking user question
218234

235+
**CRITICAL**: Never claim a task is complete without running `task ci` and `coderabbit --plain` successfully. This is non-negotiable.
236+
219237
## User preferences
220238

221239
- Keep responses short and terse in chats
@@ -312,36 +330,38 @@ This file is not set in stone, it is a living document that you should update as
312330

313331
## CRITICAL: ALWAYS TEST BEFORE CLAIMING COMPLETION
314332

315-
**NEVER claim something is done without running tests and linters for the language you're working in:**
333+
**NEVER claim something is done without completing the full workflow:**
316334

317-
For JavaScript/TypeScript projects:
335+
1. **Run `task ci`** - This single command runs ALL linters, formatters, and tests across all languages
336+
- Rust: cargo fmt, clippy, test
337+
- TypeScript/JavaScript: pnpm check, pnpm test (for all TS projects)
338+
- Docs: prettier, biome
339+
- Shell scripts: shellcheck
340+
- TOML: taplo
318341

319-
- `pnpm check` or `npm run lint` - Run linting and type checking
320-
- `pnpm test` or `npm test` - Run all tests
321-
- `pnpm build` or `npm run build` - Ensure the project builds
342+
2. **Run `coderabbit --plain`** - Get third-party AI code review
343+
- Implement ALL suggestions from CodeRabbit
344+
- Re-run `task ci` after implementing suggestions
345+
- Repeat until CodeRabbit returns no further suggestions
322346

323-
For Rust projects:
347+
3. **Only then** can you claim the task is complete
324348

325-
- `cargo build` - Ensure the project compiles
326-
- `cargo clippy` - Run linter (warnings should be treated as errors)
327-
- `cargo test` - Run all tests
328-
- `cargo fmt --check` - Check formatting
349+
**NO EXCEPTIONS.** This is the workflow. Follow it religiously.
329350

330-
For Python projects:
351+
### Legacy Individual Commands (prefer `task ci` instead)
331352

332-
- `pytest` or `python -m pytest` - Run tests
333-
- `mypy` or `pyright` - Run type checking
334-
- `ruff check` or `flake8` - Run linting
335-
- `black --check` - Check formatting
353+
For reference, here are the individual commands that `task ci` runs:
336354

337-
For Go projects:
338-
339-
- `go build` - Ensure the project compiles
340-
- `go test ./...` - Run all tests
341-
- `go vet ./...` - Run static analysis
342-
- `golangci-lint run` - Run comprehensive linting
355+
For JavaScript/TypeScript projects:
356+
- `pnpm check` - Run linting and type checking
357+
- `pnpm test` - Run all tests
358+
- `pnpm build` - Ensure the project builds
343359

344-
If you make changes to code, you MUST run these commands BEFORE saying it's complete, fixed, or working. NO EXCEPTIONS.
360+
For Rust projects:
361+
- `cargo build` - Ensure the project compiles
362+
- `cargo clippy` - Run linter (warnings are errors)
363+
- `cargo test` - Run all tests
364+
- `cargo fmt --check` - Check formatting
345365

346366
## CRITICAL: IMMEDIATE USER REQUEST EXECUTION
347367

0 commit comments

Comments
 (0)