Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
96 changes: 96 additions & 0 deletions CONTRIBUTING_JA.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,96 @@
# コントリビューションガイド

Magicにコントリビューションしていただけるとのこと、素晴らしいです。あなたが何を作ってくださるのか、楽しみでなりません。限られた人員と資金のスタートアップとして、私たちは最も強力なLLMアプリケーションを構築するという大きな野望を持っています。コミュニティからの助けはすべて、本当に大切です。

私たちは現在の状況を踏まえ、機敏に素早くリリースする必要がありますが、同時に、あなたのようなコントリビューターにできるだけスムーズなコントリビューション体験を提供したいと考えています。このガイドはそのために作成されたもので、コードベースやコントリビューターとの協業方法に慣れていただき、すぐに楽しい部分に取りかかれるようにすることを目的としています。

このガイドは、Magic自体と同様に、常に改善中です。実際のプロジェクトに対して内容が遅れている場合もありますが、ご理解いただけると幸いです。改善のためのフィードバックも歓迎します。

ライセンスについては、短い[ライセンスおよびコントリビューター同意書](./LICENSE)をお読みください。コミュニティは[行動規範](https://github.com/dtyq/.github/blob/main/CODE_OF_CONDUCT.md)にも準拠しています。

## 始める前に

取り組むものをお探しですか?[good first issues](https://github.com/dtyq/magic/issues?q=is%3Aissue%20state%3Aopen%20label%3A%22good%20first%20issue%22)を確認して、1つ選んで始めましょう!

クールなアイデアや追加したい機能がありますか?[メインリポジトリ](https://github.com/dtyq/magic)でPRを作成して、あなたの成果を見せてください。

既存の機能を更新したり、バグを修正したいですか?[メインリポジトリ](https://github.com/dtyq/magic)でPRを作成して、魔法をかけましょう!

一緒に楽しみながらコントリビューションし、素晴らしいものを作りましょう!💡✨

PRの説明には、既存のIssueをリンクするか、新しいIssueを作成することを忘れないでください。

### バグ報告

> [! IMPORTANT]
> バグ報告を提出する際は、以下の情報を含めてください:

- 明確で分かりやすいタイトル
- エラーメッセージを含むバグの詳細な説明
- バグを再現する手順
- 期待される動作
- **ログ**(利用可能な場合)。バックエンドの問題では特に重要です。k8sのログで確認できます
- スクリーンショットまたは動画(該当する場合)

優先度の決め方:

| Issue種別 | 優先度 |
| ------------------------------------------------------------ | --------------- |
| コア機能のバグ(クラウドサービス、ログイン不可、アプリケーション動作不良、セキュリティホール) | クリティカル |
| 非クリティカルなバグ、パフォーマンス改善 | 中優先度 |
| 軽微な修正(タイポ、紛らわしいが動作するUI) | 低優先度 |

### 機能リクエスト

> [! NOTE]
> 機能リクエストを提出する際は、以下の情報を含めてください:

- 明確で分かりやすいタイトル
- 機能の詳細な説明
- 機能のユースケース
- 機能リクエストに関するその他のコンテキストやスクリーンショット

優先度の決め方:

| 機能種別 | 優先度 |
| ------------------------------------------------------------ | --------------- |
| チームメンバーによってラベル付けされた高優先度の機能 | 高優先度 |
| [コミュニティフィードバックボード](https://github.com/dtyq/magic/discussions/categories/feedbacks)で人気の機能リクエスト | 中優先度 |
| コア以外の機能や軽微な改善 | 低優先度 |
| 価値はあるが緊急ではないもの | 将来の機能 |

## PRの提出

### プルリクエストのプロセス

1. リポジトリをフォーク
2. PRを作成する前に、変更内容について議論するためのIssueを作成してください
3. 変更用の新しいブランチを作成
4. 変更に応じたテストを追加してください
5. 既存のテストがパスすることを確認してください
6. PRの説明にIssueをリンクしてください(`fixes #<issue_number>`)
7. マージ!

### プロジェクトのセットアップ

#### フロントエンド

フロントエンドサービスのセットアップについては、`frontend/README.md`ファイルの包括的な[ガイド](https://github.com/dtyq/magic/blob/main/frontend/README.md)を参照してください。このドキュメントには、フロントエンド環境を正しくセットアップするための詳細な手順が記載されています。

#### バックエンド

バックエンドサービスのセットアップについては、`backend/README.md`ファイルの詳細な[手順](https://github.com/dtyq/magic/blob/main/backend/README.md)を参照してください。このドキュメントには、バックエンドをスムーズに立ち上げるためのステップバイステップのガイダンスが含まれています。

#### その他の注意事項

セットアップに進む前に、以下の重要な情報が含まれているため、このドキュメントをよく確認することをお勧めします:
- 前提条件と依存関係
- インストール手順
- 設定の詳細
- よくあるトラブルシューティングのヒント

セットアップ中に問題が発生した場合は、お気軽にご連絡ください。

## ヘルプが必要な場合

コントリビューション中に行き詰まったり、急ぎの質問がある場合は、関連するGitHub Issueを通じてお気軽にお問い合わせください。
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
<div align="left">
<a href="./README.md"><img alt="README in English" src="https://img.shields.io/badge/English-d9d9d9" height="20"></a>
<a href="./README_CN.md"><img alt="简体中文版自述文件" src="https://img.shields.io/badge/简体中文-d9d9d9" height="20"></a>
<a href="./README_JA.md"><img alt="日本語版README" src="https://img.shields.io/badge/日本語-d9d9d9" height="20"></a>
<a href="#self-hosted-deployment"><img alt="Deploy now!" src="https://img.shields.io/badge/Deploy%20now%21-red" height="20"></a>
</div>

Expand Down
1 change: 1 addition & 0 deletions README_CN.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
<div align="left">
<a href="./README.md"><img alt="README in English" src="https://img.shields.io/badge/English-d9d9d9" height="20"></a>
<a href="./README_CN.md"><img alt="简体中文版自述文件" src="https://img.shields.io/badge/简体中文-d9d9d9" height="20"></a>
<a href="./README_JA.md"><img alt="日本語版README" src="https://img.shields.io/badge/日本語-d9d9d9" height="20"></a>
<a href="#自托管部署"><img alt="现在部署!" src="https://img.shields.io/badge/现在部署%21-red" height="20"></a>
</div>

Expand Down
Loading