From 927f4f3b1039346fd677218b076bc6e74de80068 Mon Sep 17 00:00:00 2001 From: Pokey Rule <755842+pokey@users.noreply.github.com> Date: Sun, 23 Mar 2025 18:31:49 +0000 Subject: [PATCH 1/2] Add initial CLAUDE.md --- CLAUDE.md | 46 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 46 insertions(+) create mode 100644 CLAUDE.md diff --git a/CLAUDE.md b/CLAUDE.md new file mode 100644 index 0000000000..bd3e5f6a9f --- /dev/null +++ b/CLAUDE.md @@ -0,0 +1,46 @@ +# Claude Helpers for Cursorless + +This file contains helpful hints for Claude when working with the Cursorless codebase. + +## Documentation Structure + +- Main documentation is in `/packages/cursorless-org-docs/src/docs/user/README.md` +- Spoken forms are defined in `/cursorless-talon/src/spoken_forms.json` +- Contributing documentation is in `/packages/cursorless-org-docs/src/docs/contributing/` + +## Project Organization + +- Main extension code is in `/packages/cursorless-vscode/` +- Engine code is in `/packages/cursorless-engine/` +- Tests are in `data/fixtures/recorded/` +- Language-specific parsing is defined in the `queries/*.scm` files + +## Build and Test + +- Always run lint and typecheck when making changes: + - `pnpm run lint` + - `pnpm run typecheck` +- Tests can be run with: + - `pnpm test` + +## Documentation Conventions + +When documenting actions or modifiers: +- Include a brief description of what the item does +- Include the format/syntax +- Include at least one example +- For versatile actions like `drink`, `pour`, `drop`, `float`, and `puff`, explain their behavior with different scope types +- Always document special behaviors with different scope types + +## Implementation Notes + +- Many actions (`drop`, `float`, `puff`) work with both line and non-line targets +- Always check test fixtures in `/data/fixtures/recorded/` to understand behavior +- Implementation for many actions is in `/packages/cursorless-engine/src/actions/` + +## Pull Request Guidelines + +- Any feedback should be addressed in code or replied to +- Tests should be included for new functionality +- Documentation should be updated to reflect changes +- Make sure changes are consistent with the project architecture \ No newline at end of file From d8fe5c7a0249900f1f431db8d150cdece68a0313 Mon Sep 17 00:00:00 2001 From: Andreas Arvidsson Date: Sat, 29 Mar 2025 10:38:31 +0100 Subject: [PATCH 2/2] eol --- CLAUDE.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/CLAUDE.md b/CLAUDE.md index bd3e5f6a9f..321c44563c 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -26,6 +26,7 @@ This file contains helpful hints for Claude when working with the Cursorless cod ## Documentation Conventions When documenting actions or modifiers: + - Include a brief description of what the item does - Include the format/syntax - Include at least one example @@ -43,4 +44,4 @@ When documenting actions or modifiers: - Any feedback should be addressed in code or replied to - Tests should be included for new functionality - Documentation should be updated to reflect changes -- Make sure changes are consistent with the project architecture \ No newline at end of file +- Make sure changes are consistent with the project architecture