コントリビュートのガイドライン

SmallTrainへのコントリビュートのプロセス

SmallTrainへのコントリビュートの仕方は、GitHubのほとんどのオープンソースプロジェクトと同様です。それでも、はじめてオープンソースプロジェクトにコントリビュートする場合のために、以下に基本的なプロセスを記載しますので、参考にしてください。

1. 作業内容を把握します。 作業内容がわからない場合やプロジェクトの詳細を知りたい場合は、その場合のヒントとして以下に示しますので参考にしてください。
   • 問題に目を通し、修正方法を知っている問題があるかどうかを確認します。
   • 他の貢献者によって確認された問題は、調査する方が良い傾向があります。
   • また、新しい人々に役立つと思われる問題のラベルをいくつか維持しています。
2. GitHubの1つのissueとして、その変更の範囲が大きいことが想定される場合、GitHubのissueにコメントをつけます。 GitHubの1つのissueとしは、大きな範囲のissueであることが想定される場合は、GitHubのissueに設計に関連することまでコメントをつけます。小さなissueの場合は、すぐに取り掛かるようにしましょう。
3. コーディングしてください。
4. プルリクエストをしてください。 プルリクエストをする準備ができていない場合は、[WIP]でタグ付けしてください。 レビューパスを行う場合は無視します。
5. 受け入れられるまでプルリクエストを繰り返します。 プルリクエストでは次のような注意点がありますので、参考にしてください。
   • テストはしましたか?
   • プルリクエストが大きすぎませんか？
   • コードの微妙な相違の場合は、追加コメントや追加ドキュメントを使って、コードの意図をわかりやすいように説明してください。

新しいfeature（フィーチャー）の提案

新機能のアイデアについて話し合うときは、できるだけ多くの情報、付随するデータ、提案するソリューションを含めてください。

issueの立て方

1. issueを立てるときは、既存のissueを検索し、同様のissueが見つからないのを確認してから、新しいissueを作成してください。
2. issueの動作を再現するためにできるだけ多くの情報を提供し、予想される動作に関する追加の洞察を含めます。

Feature（フィーチャー）の実装またはバグフィックス

特定のissueを修正したい場合は、その意図を個々のissueにコメントするのが最善です。 ただし、以前にその開発者と作業したことがある場合を除き、issueをロックしたり割り当てたりすることはありません。 提案されたソリューションについて一緒に検討します。

ドキュメントやチュートリアルの改善

私たちは、高品質のドキュメントとチュートリアルを作成することを目指しています。 まれに、コンテンツにタイプミスやバグが含まれる場合があります。 修正を必要とする箇所を見つけたら、プルリクエストを送ってください。

• チュートリアル

コードの読みやすさの改善

コードの読みやすさを向上させることは、すべての人に役立ちます。 コードの読みやすさの改善にご協力ください。