Zoo Codeへの貢献
June 11, 2026 · View on GitHub
English • Català • Deutsch • Español • Français • हिंदी • Bahasa Indonesia • Italiano • 日本語
한국어 • Nederlands • Polski • Português (BR) • Русский • Türkçe • Tiếng Việt • 简体中文 • 繁體中文
Zoo Codeへの貢献
Zoo Codeはコミュニティ主導のプロジェクトであり、すべての貢献を深く評価しています。共同作業を円滑にするため、私たちは課題第一のアプローチで運営しています。つまり、すべてのプルリクエスト(PR)は、まずGitHubの課題にリンクされている必要があります。このガイドを注意深く確認してください。
目次
貢献する前に
1. 行動規範
すべての貢献者は、私たちの行動規範に従う必要があります。
2. プロジェクトのロードマップ
私たちのロードマップは、プロジェクトの方向性を示しています。あなたの貢献をこれらの主要な目標に合わせてください。
信頼性第一
- 差分編集とコマンド実行が一貫して信頼できることを確認します。
- 定期的な使用を妨げる摩擦点を減らします。
- すべてのロケールとプラットフォームでスムーズな操作を保証します。
- さまざまなAIプロバイダーとモデルに対する堅牢なサポートを拡大します。
ユーザーエクスペリエンスの向上
- 明確さと直感性のためにUI/UXを合理化します。
- 開発者が日常的に使用するツールに期待する高い期待に応えるために、ワークフローを継続的に改善します。
エージェントパフォーマンスのリード
- 現実世界の生産性を測定するための包括的な評価ベンチマーク(evals)を確立します。
- 誰もがこれらの評価を簡単に実行および解釈できるようにします。
- 評価スコアの明確な増加を示す改善を出荷します。
PRでこれらの分野との連携について言及してください。
3. Zoo Code コミュニティに参加しよう
貢献内容の検索と計画
貢献の種類
- バグ修正: コードの問題への対処。
- 新機能: 機能の追加。
- ドキュメント: ガイドと明確さの向上。
課題第一のアプローチ
すべての貢献は、私たちのスキニーテンプレートを使用してGitHubの課題から始まります。
- 既存の課題を確認する:GitHubの課題で検索します。
- 課題を作成する:
- 機能強化: 「機能強化リクエスト」テンプレート(ユーザーの利益に焦点を当てた平易な言葉)。
- バグ: 「バグレポート」テンプレート(最小限の再現+期待値と実際値+バージョン)。
- それに取り組みたいですか? 課題に「Claiming」とコメントし、Discordのコアチームに連絡して割り当てを受けてください。割り当てはスレッドで確認されます。
- PRは課題にリンクする必要があります。 リンクされていないPRはクローズされる場合があります。
何に取り組むかを決める
- issue を探すには GitHub Issues ページ を確認してください。
- ドキュメントについては、Zoo Codeドキュメントをご覧ください。
バグの報告
- 最初に既存のレポートを確認してください。
- 次の情報を含む「バグレポート」テンプレートを使用して新しいバグを作成します。
- 明確で番号付きの再現手順
- 期待される結果と実際の結果
- Zoo Codeのバージョン(必須)。関連する場合はAPIプロバイダー/モデル
- セキュリティの問題:セキュリティアドバイザリを介して非公開で報告してください。
開発と提出のプロセス
開発のセットアップ
- フォークとクローン:
git clone https://github.com/YOUR_USERNAME/Zoo-Code.git
- 依存関係のインストール:
pnpm install
- デバッグ: VS Codeで開きます(
F5)。
コーディングのガイドライン
- 機能または修正ごとに1つの焦点を絞ったPR。
- ESLintとTypeScriptのベストプラクティスに従ってください。
- 課題を参照する明確で説明的なコミットを作成します(例:
Fixes #123)。 - 徹底的なテストを提供します(
npm test)。 - 提出前に最新の
mainブランチにリベースします。
プルリクエストの提出
- 早期のフィードバックを求める場合は、ドラフトPRとして開始します。
- プルリクエストテンプレートに従って、変更内容を明確に説明します。
- PRの説明/タイトルに課題をリンクします(例:「Fixes #123」)。
- UIの変更については、スクリーンショット/ビデオを提供します。
- ドキュメントの更新が必要かどうかを示します。
プルリクエストポリシー
- 割り当てられたGitHubの課題を参照する必要があります。割り当てを受けるには、課題に「Claiming」とコメントし、Discordのコアチームに連絡してください。割り当てはスレッドで確認されます。
- リンクされていないPRはクローズされる場合があります。
- PRはCIテストに合格し、ロードマップに沿っており、明確なドキュメントが必要です。
レビュープロセス
- 毎日のトリアージ: メンテナーによる簡単なチェック。
- 毎週の詳細なレビュー: 包括的な評価。
- フィードバックに基づいて迅速に反復します。
プルリクエストへの期待
プルリクエストはレビュー可能で、テストされており、保守可能である必要があります。PRを開く前に、以下を確認してください。
- 変更は特定のイシュー、バグ、または改善に限定されている。
- 変更が何をするのか、なぜ正しいのかを説明できる。
- 可能な限りローカルで変更をテストした。
- レビューフィードバックに応答し、合理的なフォローアップ変更を行う意思がある。
- PRをマージする前に、メンテナーが実装を大幅に書き直したり、再設計したり、所有権を取得したりする必要がない。
メンテナーは、不完全なPR、範囲が広すぎるPR、非活性なPR、プロジェクトの方向性に沿っていないPR、または不釣り合いなレビューや保守の負担を生じさせるPRを閉じることができます。PRを閉じることはコントリビューターへの判断ではありません。それは変更が現在の形では受け入れられないというメンテナーの判断です。
AIを利用した貢献
AIツールの使用は許可されていますが、コントリビューターは自分の提出物に対して完全な責任を負います。
PRの作成にAIツールを使用する場合は、以下が必要です。
- すべての重要な変更をレビューして理解する。
- 実装とトレードオフを自分の言葉で説明できる。
- 自分で変更をテストする。環境でテストが実行できない場合は、PRの説明でその理由を説明し、レビュアーが変更を検証できる方法を記述する。
- 生成されたコードが正確で、必要であり、プロジェクトのライセンスと互換性があることを確認する。
- AIがコード、テスト、または設計を大きく形作った場合は、PRの説明でAI支援を開示することを検討する — これによりレビュアーがより良いフィードバックを提供できる。
理解していない、またはレビューを通じて維持できないAI生成の変更を提出しないでください。メンテナーは、実質的にAI支援と思われるが、人間による検証、明確な根拠、またはレビューのフォロースルーが欠如しているPRを閉じることができます。
法務
貢献することにより、あなたの貢献がZoo Codeのライセンスと一致するApache 2.0ライセンスの下でライセンスされることに同意したことになります。