docs: add CLAUDE.md for Claude Code integration #173
Conversation
Provides comprehensive guidance including development commands, architecture overview, and key patterns for enhanced productivity when working with Claude Code. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
There was a problem hiding this comment.
Hello @koki-develop, 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!
Summary of Changes
Hello! Gemini or gemini-code-assist here, providing a summary of this pull request to help everyone get up to speed quickly. This PR introduces a new documentation file, CLAUDE.md, specifically designed to provide guidance for Claude Code when interacting with this repository's codebase. The file includes essential information such as development commands (testing, building, linting, running), an overview of the project's architecture and key data flows, details on tool configuration, and the testing strategy. This comprehensive guide aims to enhance productivity and understanding for anyone using Claude Code with this project, and it's noted that the file itself was generated with Claude Code.
Highlights
- New Documentation File: Adds a new file,
CLAUDE.md, dedicated to guiding AI code assistants, specifically Claude Code, on how to work with this repository. - Development Workflow: Includes sections detailing standard development commands for testing, building, linting, and running the project.
- Architecture Overview: Provides a breakdown of the project's core components (CLI, Engine, Formatters, Lexers, Prettification, Themes) and explains the key data flow.
- Tooling and Strategy: Documents the project's use of tools like
mise.toml,goreleaser, and GitHub Actions, and outlines the testing strategy.
Changelog
- CLAUDE.md
- Added a new file (
CLAUDE.md) containing documentation for Claude Code integration. - Includes sections on Development Commands, Architecture, Tool Configuration, and Testing Strategy.
- Added a new file (
Using Gemini Code Assist
The 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 in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
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 .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist is currently in preview and 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 to provide feedback.
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.
New docs take their place,
Guiding AI with good grace,
Code flows with new pace.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Pull Request Overview
This PR adds a new CLAUDE.md document to guide usage of Claude Code within the repository, covering development commands, architecture, tooling, and testing strategy.
- Introduces step-by-step dev commands (test, build, lint, run)
- Documents core architecture and data flow of the application
- Details tool configuration and testing approach
Comments suppressed due to low confidence (3)
CLAUDE.md:3
- Make the link to Claude Code clickable by using markdown link syntax, e.g.,
guidance to [Claude Code](https://claude.ai/code).
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
CLAUDE.md:5
- Consider adding a
## Prerequisitessection before this block to list required Go version, environment variables, and any other setup steps.
## Development Commands
CLAUDE.md:91
- [nitpick] Wrap
mise.tomlin backticks for consistency with other filenames and commands in this doc, e.g., "mise.toml: Tool version management...".
- **mise.toml**: Tool version management (Go 1.24.3, golangci-lint, vhs, goreleaser)
There was a problem hiding this comment.
Code Review
The pull request introduces a new CLAUDE.md file that provides guidance for Claude Code when working with the repository. The document covers development commands, architecture overview, key data flow, special features, tool configuration, and testing strategy. Overall, the documentation seems comprehensive and well-structured. However, there are a few areas that could be improved for clarity and consistency.
Summary of Findings
- Inconsistent List Styles: The document uses a mix of hyphens and numbers for list items. Using a consistent style (e.g., hyphens) throughout the document would improve readability.
- Lack of Detail in Key Data Flow: The numbered list under "Key Data Flow" could benefit from more detailed explanations for each step to enhance user understanding.
Merge Readiness
The CLAUDE.md documentation provides valuable guidance for Claude Code integration. Addressing the inconsistent list styles and adding more detail to the "Key Data Flow" section would further enhance the document's clarity and usefulness. I am unable to approve this pull request, and users should have others review and approve this code before merging. I recommend addressing the medium severity issues before merging.
| Tests focus on: | ||
| - Format and language listing functionality | ||
| - Code prettification for each supported language |
There was a problem hiding this comment.
Consider using a consistent style for list items. Currently, you're using hyphens (-) for some list items and numbers for others. Using hyphens consistently throughout the document would improve readability and maintainability.
| Tests focus on: | |
| - Format and language listing functionality | |
| - Code prettification for each supported language | |
| - Format and language listing functionality | |
| - Code prettification for each supported language | |
| - Error handling and edge cases in prettier modules |
There was a problem hiding this comment.
Good catch! I've updated the "Key Data Flow" section to use consistent hyphens instead of numbered list items, making it consistent with the rest of the document formatting.
Use consistent hyphens for all list items instead of mixing numbered and bulleted lists. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
Summary
🤖 Generated with Claude Code