Siv3D へのコントリビューションガイド¶
Siv3D へのコミットを検討いただきありがとうございます。
プロジェクトを改善する取り組みと貢献に感謝いたします。
このガイドでは、コントリビューションをできるだけスムーズに行う方法について説明します。
ブランチ戦略¶
2 つのメインブランチがあります。
v6_develop開発用main安定版
適切なブランチからフォークし、そこで変更を行ってください。
指示がない限り、プルリクエストは v6_develop ブランチに送信してください。
プルリクエストの作成¶
- GitHub アカウントにリポジトリをフォークします。
- フォークしたリポジトリをローカルマシンにクローンします。
- 機能追加や修正のために新しいブランチを作成します。
- コーディングスタイルに従って変更を行います。
- コミットガイドラインに従ってコミットします。
- 変更をフォークにプッシュします。
- 変更内容を説明するコメントを書いてプルリクエストを作成します。
コミットガイドライン¶
- 1 つのプルリクエストに複数のコミットがあっても構いません。
- コミットメッセージは明確で簡潔にしてください。
- 可能であれば、関連する Issue 番号をコミットメッセージで参照してください。
議論とコミュニケーション¶
- 大きな変更や新機能については、作業を開始する前に Siv3D Discord サーバーや GitHub Issues を通じてメンテナーと相談してください。
- コントリビューションプロセスのどの段階でも、質問や説明を求めることができます。
ライブラリのビルド¶
- Siv3D ライブラリを自分でビルドする方法の詳細については、ビルド手順を参照してください。
プルリクエストの例¶
機能に影響を与えない些細な変更や修正の場合は、Issue を作成せずに直接プルリクエストを作成することもできます。
OpenSiv3D 実装会¶
GitHub の操作に不慣れな場合は、Siv3D Discord サーバーや OpenSiv3D 実装会でサポートします。