Improve and restructure README documentation for better clarity Issue 161
評価
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 初心者へのやさしさ
- 45/100
- issue の種類
- ドキュメント
- 明瞭さ
- おおむね明確
- 活発さ
- 停滞
- 技術スタック
- aws, docker-compose, mysql, python
- 領域
- backend, databases, devops, documentation
調査の方向性
README.md から始め、アーキテクチャと利用可能なコマンドを確認するために、issue に記載されている services、migrations、localstack scripts、Keploy tests、Postman collections を調査します。リポジトリの既存の構成を使用して、サービスの責務、データベースの分離、SQS ワークフロー、セットアップとテストの手順、およびコントリビューションの手順を文書化します。README.md が機能変更なしにすべての受け入れ基準を網羅すれば完了です。
索引モデルが issue の本文から書いたものです。
説明
Overview
The current README.md lacks detailed documentation about the project architecture, service responsibilities, setup instructions, testing workflow, and contribution guidelines. This can make onboarding difficult for new contributors and users trying to run the project locally.
Proposed Changes
Update the README to include:
1. Architecture Overview
Clear explanation of all services:
-
API Gateway
-
Order Service
-
Product Service
-
User Service
-
Infrastructure components:
-
MySQL per service
-
Docker Compose orchestration
-
LocalStack SQS messaging
2. Project Structure
- Add a complete directory tree.
Explain purpose of key folders:
-
services
-
migrations
-
keploy tests
-
localstack scripts
-
postman collections
-
coverage reports
3. Setup Instructions
Provide clear commands for:
-
Starting services
-
Viewing logs
-
Stopping services
4. Service Responsibilities
Document responsibilities for each service including:
-
Order lifecycle
-
Product inventory handling
-
User validation
-
API gateway routing
5. Database Documentation
Explain:
-
Migration usage
-
Schema files
-
DB isolation per service
6. Messaging Workflow
Document:
-
SQS usage
-
Queue setup scripts
-
Event-driven communication
7. Testing Documentation
Add explanation for:
-
Keploy testing setup
-
AI-generated tests (test1.yaml → test36.yaml)
-
Manual tests
-
Coverage reports
8. Contribution Guidelines
Add steps for contributors:
-
Fork
-
Branch creation
-
Testing
-
Pull request submission
-
Expected Outcome
-
Better onboarding experience.
-
Easier understanding of project structure.
-
Clear testing workflow.
-
Improved contributor experience.
Additional Context
This update is documentation-only and does not introduce any functional changes.
-
Acceptance Criteria
-
README includes architecture overview.
-
Setup instructions are clear.
-
Project structure documented.
-
Testing workflow explained.
-
Contribution steps included.
- 主要言語
- Python
- スター
- 3
- フォーク
- 11
- 平均マージ
- 1時間 6分
- マージ済み PR（30日）
- 3
環境構築
- Dockerfile または Docker Compose ファイルあり
- プルリクエストのテンプレートなし
- コントリビューションガイドなし
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
keploy/ecommerce_sample_app のほかの issue
-
Hardcoded Credentials Security Issue T152再び着手できるかも @Talaviya-Sarthak が 255 日前に担当しましたが、オープン中のプルリクエストはありません。 オープン
難易度 4/5 3〜5日 初心者へのやさしさ 32/100
keploy/ecommerce_sample_app#7 · コメント 1 件 ·
-
難易度 4/5 3〜5日 初心者へのやさしさ 35/100
keploy/ecommerce_sample_app#6 · コメント 1 件 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 55/100
keploy/ecommerce_sample_app#5 · コメント 1 件 ·
-
難易度 4/5 3〜5日 初心者へのやさしさ 42/100
keploy/ecommerce_sample_app#4 · コメント 1 件 ·
keploy/ecommerce_sample_app の issue をすべて見る
似ている issue
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 69/100
jejjohnson/gaussx#752 ·
メンテナーはふだん 1 日以内に返信
-
難易度 1/5 1時間未満 初心者へのやさしさ 85/100
521xueweihan/HelloGitHub#4270 ·
-
enhancement owner: den-haag
難易度 2/5 1〜3時間 初心者へのやさしさ 67/100
メンテナーはふだん 6 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
ok-oldking/ok-wuthering-waves#1828 ·
メンテナーはふだん 1 日以内に返信
-
lesson-submission pending-review
難易度 1/5 1時間未満 初心者へのやさしさ 65/100
Ikalus1988/MisakaNet#4512 ·
メンテナーはふだん 1 日以内に返信