Skip to content

Latest commit

 

History

History
84 lines (64 loc) · 5.63 KB

CONTRIBUTING.md

File metadata and controls

84 lines (64 loc) · 5.63 KB
Raw

Scenamatica への貢献

まず初めに、Scenamatica への貢献に感謝します。Scenamatica は、 KUN Lab メンバと OSS コミュニティの協力によって開発されています。
貴重な時間を割いていただき、ありがとうございます。

あらゆる種類の貢献が奨励され、歓迎されています。様々な貢献方法とメンテナの対応については、以下のガイドラインを参照してください。
また、貢献前には必ず関連するセクションをお読みください。これにより、あなたの貢献がよりスムーズに行なえます。

もしプロジェクトが気に入っており、でも時間がない場合でも大丈夫です！ 以下のような方法でも十分に貢献できます。

行動規範

このプロジェクトに参加するすべての人は、 Scenamatica 行動規範に遵守する必要があります。
容認できない行為は、プロジェクトのメンテナによって削除されたり、参加を拒否されることがあります。

質問がありますか？

質問をする場合は、 Scenamatica ドキュメントを参照したことを前提としています。

質問をする前に、既知の問題 を探すことをおすすめします。適切な問題を見つけ、コメントを残せます。
また、最初にインターネットで検索することもおすすめします。

それでも解決しない場合は、こちら をクリックし、問題の作成を開始します。 ウィザードに従って、質問の内容を記入してください。

また、あなたの行った質問はドキュメントに追加されたり、よくある質問に追加されることがあります。

バグを見つけたり、機能の提案がありますか？

これらをリクエストする前に、既知の問題を探すことをおすすめします。
既存の機能の提案にコメントしたり、バグの多重報告を防いだりします。

それでも解決しない場合は、以下のリンクをクリックし、問題の作成を開始します。その後のウィザードに従って、問題の内容を記入してください。

プロジェクトにコードを貢献する

コードでの貢献は常に歓迎されます。 ただし、以下の点に注意してください。

  • 上流ブランチは main です。
    プルリクエストは、 main ブランチに対して作成してください。
  • 既存のコードスタイルに従ってください。
    Scenamatica では主なスタイルとして、 BSD(Allman) スタイルを採用しています。 また、コードのインデントには４つのスペースを使用してください。
    丸かっこ内の始まりにはスペースを入れないでください。
    if や while などの制御構文の後には、スペースを入れてください。
  • プルリクエストのタイトル及びコミットメッセージは Conventional Commits に従ってください。
    これにより、コミット/PR が行う変更が明確になり、スコープの調整が容易になります。

プロジェクトの構成

このプロジェクトは、以下の１０つのモジュールから構成されています。