Skip to content

コントリビュート

Koharu では、焦点を絞ったバグ修正、ドキュメント改善、モデル移植の修正、明確な製品機能を歓迎します。

コーディング前

  1. Issue と既存 PR を検索します。
  2. 大きな挙動・設計変更は着手前に Issue を作成します。
  3. AGENTS.md と変更対象クレートの README を読みます。
  4. 生成物、モデル重み、データセット、認証情報、ビルド出力、端末固有ファイルをコミットしません。

変更の原則

  • API やスキーマを変えたらリポジトリ内の全利用側を更新し、互換エイリアスを追加しません。
  • プロバイダー固有の既定値と要求変換はそのプロバイダーに置きます。
  • 安全な API と unsafe FFI・動的ロードを分離します。
  • 上流モデル移植ではチェックポイントに影響する構造を保ち、同一入力の構造化出力を比較します。
  • 実際の対象デバイスと代表入力で最適化し、速度と正しさの両方を報告します。

コメントは所有、制約、上流対応、意図的差分を説明し、単純なコードを読み上げないでください。

検証と PR

変更に最小限必要な debug プロファイルのチェックまたはテストを 1 回実行します。無関係なフルスイートを毎回実行する必要はありません。Rust と TypeScript を整形し、git diff --check を実行してください。

PR には問題、所有境界、重要な挙動・スキーマ変更、実行したコマンドと結果、UI のスクリーンショット、性能変更のデバイス・入力・基準・結果・正しさを含めます。

生成 AI を大きく利用した場合は明示してください。提出内容を理解・レビュー・テストする責任は投稿者にあります。

バグや予定している変更には GitHub Issues を使い、設計上の質問やコミュニティサポートには Discord を使ってください。