Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 44 additions & 0 deletions AGENTS.md
Original file line number Diff line number Diff line change
@@ -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
44 changes: 1 addition & 43 deletions CLAUDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy link
Member

Choose a reason for hiding this comment

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

I'm guessing you'd prefer to not just symlink CLAUDE.md -> AGENTS.md for maximum Windows support?

Copy link
Member Author

Choose a reason for hiding this comment

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

This seemed like a nicer option. So not the individual developers need to create sym links.

Copy link
Member

Choose a reason for hiding this comment

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

I'm suggesting we could check in a symlink, if we're not worried about people not being able to create symlinks. I know on Windows users creating symlinks is only allowed when dev mode is enabled, but I always enable dev mode on my own Windows machines.

Copy link
Member

Choose a reason for hiding this comment

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

https://agents.md/ does suggest symlinking, FWIW.

Loading