From 0de66618ffabd13add8edc9041e8f2dc661a01fd Mon Sep 17 00:00:00 2001 From: Andreas Arvidsson Date: Mon, 9 Feb 2026 14:34:52 +0100 Subject: [PATCH 1/2] CLAUDE.md imports AGENTS.md --- AGENTS.md | 44 ++++++++++++++++++++++++++++++++++++++++++++ CLAUDE.md | 44 +------------------------------------------- 2 files changed, 45 insertions(+), 43 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index 808af06e0c..4ee2c9bcbf 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -1,5 +1,49 @@ # AGENTS.md +## 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/` + ## Scope test format When writing or updating `.scope` files please follow the guidelines in [scope-test-format.md](./packages/cursorless-org-docs/src/docs/contributing/scope-test-format.md) + +## 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 diff --git a/CLAUDE.md b/CLAUDE.md index 321c44563c..2d40170c92 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -2,46 +2,4 @@ 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 +@AGENTS.md From 2d013fc6d6e6c8db48da612eb01553ca10c8550c Mon Sep 17 00:00:00 2001 From: Andreas Arvidsson Date: Wed, 11 Feb 2026 07:50:16 +0100 Subject: [PATCH 2/2] Remove CLAUDE.md --- CLAUDE.md | 5 ----- 1 file changed, 5 deletions(-) delete mode 100644 CLAUDE.md diff --git a/CLAUDE.md b/CLAUDE.md deleted file mode 100644 index 2d40170c92..0000000000 --- a/CLAUDE.md +++ /dev/null @@ -1,5 +0,0 @@ -# Claude Helpers for Cursorless - -This file contains helpful hints for Claude when working with the Cursorless codebase. - -@AGENTS.md