docs: add CLAUDE.md for AI-assisted development #431
Conversation
Provides comprehensive guidance for Claude Code instances working in this repository, including development commands, architecture patterns, code quality standards, and security considerations across all supported languages. Co-Authored-By: Claude Sonnet 4.5 <[email protected]>
Summary of ChangesHello @2squirrelsai, 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 introduces a dedicated documentation file, 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
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request adds a CLAUDE.md file to guide AI-assisted development in the repository. The document is comprehensive and well-structured, covering project overview, architecture, development commands for multiple languages, code quality standards, and more. My review focuses on ensuring the accuracy and clarity of the development commands. I've suggested a few corrections to the JavaScript and .NET commands to prevent errors and improve usability, and a minor formatting fix for consistency. Overall, this is an excellent addition that will be very helpful for developers and AI assistants working with this codebase.
| ```bash | ||
| cd samples/js | ||
| pnpm install | ||
| pnpm run build |
There was a problem hiding this comment.
The pnpm run build command will fail because the build script is not defined in samples/js/package.json. The other scripts use tsx for on-the-fly execution, which suggests a separate build step might not be required for the development workflows described here. I recommend removing this line for accuracy.
| cd samples/dotnet | ||
| dotnet restore | ||
| dotnet build | ||
| dotnet run | ||
| dotnet test |
There was a problem hiding this comment.
The dotnet run command is likely to fail without specifying a project, as the solution in samples/dotnet/BasicA2ADemo contains multiple runnable projects. Also, the commands should be run from the solution directory. I suggest updating the commands to be more specific and accurate for a better developer experience.
| cd samples/dotnet | |
| dotnet restore | |
| dotnet build | |
| dotnet run | |
| dotnet test | |
| cd samples/dotnet/BasicA2ADemo | |
| dotnet restore | |
| dotnet build | |
| # Run a specific project (e.g., SimpleClient) | |
| dotnet run --project SimpleClient | |
| dotnet test |
| │ ├── go/ # JSON-RPC 2.0 compliant implementation | ||
| │ └── dotnet/ # .NET 9.0 samples with Semantic Kernel | ||
| ├── extensions/ # Protocol extensions (AGP, secure-passport, timestamp, traceability) | ||
| ├── demo/ui/ # Mesop web app demo |
There was a problem hiding this comment.
For better readability and consistency, the comment for demo/ui should be aligned with the other comments in the repository structure diagram.
| ├── demo/ui/ # Mesop web app demo | |
| ├── demo/ui/ # Mesop web app demo |
2 participants
Summary
Adds a CLAUDE.md file to provide comprehensive guidance for Claude Code instances working in this repository.
What's Included
Purpose
This file helps future instances of Claude Code be productive more quickly by providing:
The file is concise (267 lines), scannable, and focuses on information that isn't obvious from the file structure alone.
🤖 Generated with Claude Code