Skip to content

新規開発者向けドキュメントの追加#150

Merged
yu23ki14 merged 2 commits intomainfrom
devin/1745812774-add-developer-documentation
Apr 28, 2025
Merged

新規開発者向けドキュメントの追加#150
yu23ki14 merged 2 commits intomainfrom
devin/1745812774-add-developer-documentation

Conversation

@devin-ai-integration
Copy link
Contributor

新規開発者向けドキュメントの追加

このPRでは、BirdXplorerの新規開発者向けのドキュメントを追加しています。ドキュメントは以下の内容をカバーしています:

  • toxコマンドでテスト環境を構築する方法
  • Dockerで開発環境を立ち上げる方法
  • DBマイグレーションを実行する方法
  • SwaggerでAPIスペックを確認する方法

変更内容

  • docs/developer_guide.md - 新規開発者向けの包括的なガイドを追加

Link to Devin run

https://app.devin.ai/sessions/9a45d0eb4e14415287bac808933f0a3b

Requested by

[email protected]

@devin-ai-integration
Copy link
Contributor Author

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

Copy link
Collaborator

@yu23ki14 yu23ki14 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

以下2点変更

Comment on lines +48 to +58
各モジュールディレクトリで以下のコマンドを実行します:

```bash
# commonモジュールのテスト
cd common
tox

# apiモジュールのテスト
cd ../api
tox
```
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

cd commonと cd ../apiと連続させるのではなく、それぞれ個別にして


## 1. toxコマンドでテスト環境を構築する

BirdXplorerは複数のPythonモジュール(api, common, etl, migrate)で構成されています。各モジュールは独自のpyproject.tomlファイルを持ち、toxを使用してテスト環境を構築できます。
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't use etl in this repo anymore

@yu23ki14 yu23ki14 merged commit 54df783 into main Apr 28, 2025
3 checks passed
@ayuki-joto ayuki-joto deleted the devin/1745812774-add-developer-documentation branch August 18, 2025 06:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant