Skip to content

Commit 927f4f3

Browse files
committed
Add initial CLAUDE.md
1 parent 34a6bf5 commit 927f4f3

File tree

1 file changed

+46
-0
lines changed

1 file changed

+46
-0
lines changed

CLAUDE.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Claude Helpers for Cursorless
2+
3+
This file contains helpful hints for Claude when working with the Cursorless codebase.
4+
5+
## Documentation Structure
6+
7+
- Main documentation is in `/packages/cursorless-org-docs/src/docs/user/README.md`
8+
- Spoken forms are defined in `/cursorless-talon/src/spoken_forms.json`
9+
- Contributing documentation is in `/packages/cursorless-org-docs/src/docs/contributing/`
10+
11+
## Project Organization
12+
13+
- Main extension code is in `/packages/cursorless-vscode/`
14+
- Engine code is in `/packages/cursorless-engine/`
15+
- Tests are in `data/fixtures/recorded/`
16+
- Language-specific parsing is defined in the `queries/*.scm` files
17+
18+
## Build and Test
19+
20+
- Always run lint and typecheck when making changes:
21+
- `pnpm run lint`
22+
- `pnpm run typecheck`
23+
- Tests can be run with:
24+
- `pnpm test`
25+
26+
## Documentation Conventions
27+
28+
When documenting actions or modifiers:
29+
- Include a brief description of what the item does
30+
- Include the format/syntax
31+
- Include at least one example
32+
- For versatile actions like `drink`, `pour`, `drop`, `float`, and `puff`, explain their behavior with different scope types
33+
- Always document special behaviors with different scope types
34+
35+
## Implementation Notes
36+
37+
- Many actions (`drop`, `float`, `puff`) work with both line and non-line targets
38+
- Always check test fixtures in `/data/fixtures/recorded/` to understand behavior
39+
- Implementation for many actions is in `/packages/cursorless-engine/src/actions/`
40+
41+
## Pull Request Guidelines
42+
43+
- Any feedback should be addressed in code or replied to
44+
- Tests should be included for new functionality
45+
- Documentation should be updated to reflect changes
46+
- Make sure changes are consistent with the project architecture

0 commit comments

Comments
 (0)