Skip to content

feat: add CLAUDE.md to share project guidelines with claude code #2029

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
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

thoo
Copy link

@thoo thoo commented Jul 18, 2025

Summary

  • Add CLAUDE.md that directs Claude Code to read AGENTS.md for all project guidelines
  • Enables AI tools to automatically follow project conventions when creating PRs

Changes

  • Created CLAUDE.md with simple reference to AGENTS.md
  • Ensures consistent code style, import patterns, and testing practices in AI-generated contributions

Closes #2027

Copy link

google-cla bot commented Jul 18, 2025

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

@thoo thoo force-pushed the claude-to-agents-md branch from aadd42b to c1a7b13 Compare July 18, 2025 03:08
@thoo thoo changed the title Share project guidelines with claude code feat: add CLAUDE.md to share project guidelines with claude code Jul 18, 2025
@hangfei
Copy link
Collaborator

hangfei commented Jul 18, 2025

Thanks @thoo . Do you know if Claude can follow that file or we need some links?

@hangfei hangfei self-requested a review July 18, 2025 21:27
@thoo
Copy link
Author

thoo commented Jul 18, 2025

It does. I have been using the similar setup in openai-agent-sdk here with claude code.

@wyf7107 wyf7107 added the ready to pull [Status] This PR is ready to be importing back to Google label Jul 18, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ready to pull [Status] This PR is ready to be importing back to Google
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Point CLAUDE.md to AGENTS.md
3 participants