feat: add Claude Code review workflows and CLAUDE.md documentation#85
feat: add Claude Code review workflows and CLAUDE.md documentation#85think-in-universe merged 1 commit intomainfrom
Conversation
Summary of ChangesHello @henrypark133, 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 integrates a dedicated "CLAUDE.md" document to guide Claude Code on interacting with the repository, with a strong focus on privacy, data security, and logging protocols. It also provides a thorough project overview and development instructions, alongside an update to the ".gitignore" file to manage markdown documentation effectively. Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Ignored Files
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.
Code Review
This pull request introduces a CLAUDE.md file to provide context and guidelines for AI-assisted code review, and updates the .gitignore file. The CLAUDE.md is comprehensive and well-structured, with a strong emphasis on data privacy and security, which is excellent. The changes to .gitignore are also appropriate. My review includes a couple of minor suggestions to enhance the clarity and completeness of the development instructions in CLAUDE.md.
| cargo build # Debug build | ||
| cargo build --release # Release build | ||
|
|
||
| # Run locally (requires PostgreSQL and .env file) |
There was a problem hiding this comment.
This section is very helpful for running the application locally. To make it even more self-contained, consider adding a quick-start command for setting up the required PostgreSQL database using Docker. This would lower the barrier for new contributors to get the project running.
| # Run locally (requires PostgreSQL and .env file) | |
| # Run locally (requires PostgreSQL and .env file) | |
| # Example to run PostgreSQL with Docker: docker run --name chat-api-db -e POSTGRES_PASSWORD=postgres -e POSTGRES_DB=chat_api -p 5432:5432 -d postgres |
| cargo run --bin api | ||
|
|
||
| # Run tests | ||
| cargo test --features test # All tests with mock-login endpoint |
There was a problem hiding this comment.
The comment for this test command could be more precise. Since the E2E tests are ignored by default, this command runs all unit and integration tests. Clarifying this will help developers (and AI) understand exactly which tests are being executed.
| cargo test --features test # All tests with mock-login endpoint | |
| cargo test --features test # Run unit & integration tests (excludes ignored E2E tests) |
The Claude Code Workflow won't work for this PR. We will need to wait until this PR is merged to test it.