-
Notifications
You must be signed in to change notification settings - Fork 458
Make CLAUDE instructions symlink #1206
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
Make CLAUDE instructions symlink #1206
Conversation
Summary of ChangesHello @finbarrtimbers, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request streamlines the project's documentation by consolidating common development instructions. It replaces the content of Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
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.
Code Review
This pull request aims to replace CLAUDE.md with a symbolic link to a new AGENTS.md file, which now contains the development instructions. While the content has been successfully moved to AGENTS.md, the CLAUDE.md file is not a symbolic link but a plain text file containing the string "AGENTS.md". My review includes a suggestion to make CLAUDE.md a proper markdown file with a link to AGENTS.md for better usability. I've also included a minor suggestion to improve the clarity of a command description in AGENTS.md.
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.
Bug: Incorrect file type breaks documentation content.
CLAUDE.md contains literal text "AGENTS.md" instead of being a symbolic link. The file is a regular text file, not a symlink, so reading CLAUDE.md returns unhelpful text rather than the actual documentation content from AGENTS.md. Symbolic links require creation via ln -s and show differently in git diffs (mode 120000).
CLAUDE.md#L1-L1
Line 1 in 68dee40
| AGENTS.md |
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.
Bug: CLAUDE.md: Wrong file type
CLAUDE.md is a text file containing "AGENTS.md" rather than an actual symbolic link. This means opening CLAUDE.md displays the text "AGENTS.md" instead of the agent instructions, breaking the intended functionality described in both the PR description and README.md that claims it's a symbolic link for backward compatibility with older tooling.
CLAUDE.md#L1-L1
Line 1 in d493d6a
| AGENTS.md |
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.
Bug: Documentation link is just a text file.
CLAUDE.md is a regular text file containing the string AGENTS.md rather than an actual symbolic link to AGENTS.md. This means opening CLAUDE.md displays only the text "AGENTS.md" instead of the intended documentation content. The file needs to be created as a filesystem symlink using ln -s rather than as a text file.
CLAUDE.md#L1-L1
Line 1 in 8545166
| AGENTS.md |
saurabh111233212
left a comment
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.
a great change for codex enjoyers like myself.
or maybe ur doing it for gemini 3? Lmao
Summary
CLAUDE.mdresolves directly toAGENTS.mdTesting
make style(fails: unable to download torch==2.8.0+cu128 from download.pytorch.org due to tunnel error)uv run pytest(fails: unable to download torch==2.8.0+cu128 from download.pytorch.org due to tunnel error)Codex Task
Note
Move instructions into
AGENTS.mdand makeCLAUDE.mda symlink-style pointer to it.AGENTS.md: Added developer commands and workflow guidelines (tests, lint/format, training launch scripts).CLAUDE.md: Replaced full content with a symlink-style reference toAGENTS.md(removes duplicated instructions).Written by Cursor Bugbot for commit 8545166. This will update automatically on new commits. Configure here.