-
-
Notifications
You must be signed in to change notification settings - Fork 93
CLAUDE.md imports AGENTS.md #3165
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
AndreasArvidsson
wants to merge
1
commit into
main
Choose a base branch
from
claudemd
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+45
−43
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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.mdfor maximum Windows support?There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.