Update README.md with comprehensive development information #1007
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Add tech stack overview (Go/Next.js/OpenAPI) - Add development commands and workflow - Add project structure and port configuration - Add AI development support information - Reorganize documentation links for better structure - Add important notes about code generation and quality 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
Collaborator
Author
|
LGTM by Gemini |
- Add comprehensive Mermaid diagram showing system components - Visualize Clean Architecture pattern and data flow - Show OpenAPI-driven development workflow - Add color-coded component categorization - Include architecture characteristics explanation 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
There was a problem hiding this comment.
Pull Request Overview
A comprehensive update to the project’s README to onboard new developers with detailed setup, tooling, and workflow guidance.
- Added an overview of the tech stack for backend, frontend, and infrastructure
- Organized development commands, project structure, and workflow diagrams
- Introduced AI-assisted development notes and important code generation rules
Comments suppressed due to low confidence (3)
README.md:33
- The closing of the first code block under "基本セットアップ" is followed by stray removal markers and old lines. Remove any leftover diff artifacts or ensure the code fence encloses only the intended commands.
**README.md:42**
* The Docker Compose filename differs from the earlier reference (`docker-compose.db.yml`). Consider unifying the filename and command style (either `docker-compose` or `docker compose`) for consistency.
docker compose -f compose.db.yml up -d
**README.md:216**
* The list items in the AI 開発支援 section are missing a space after the dash. Update to `- **CLAUDE.md**` and `- **GitHub Copilot**` to follow Markdown list syntax.
- CLAUDE.md - Claude Code 用の開発ガイダンス
</details>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
対応Issue
特定のIssueはありませんが、新しい開発者向けのドキュメント改善
概要
画面スクリーンショット等
該当なし（ドキュメントの更新のため）
テスト項目
備考
既存の情報は極力保持し、新しい情報を追加する形で更新しました。
CLAUDE.mdと合わせて、AI支援開発がより効率的になります。
🤖 Generated with Claude Code