HOW TO CONTRIBUTE

English guideline is here.

当プロジェクトに関心を寄せていただき、ありがとうございます。このプロジェクトはオープンソースであるため、誰でもプロジェクトに貢献することができます。皆様がプロジェクトへの貢献を円滑に行えるよう、以下の事項を守っていただけますようお願いします。

Getting Started

重複する Issue がないかどうか、はじめに検索してください。
機能要望(新機能の追加、既存機能の変更など)には、必ず Issue を作成してください。
- 小さなバグ修正やリファクタリングなどは、Issue を作成せずに直接 Pull Request を送っても構いません。ただし、規模が大きい場合は、事前に Issue を作成し、了解を取ってから作業を始めてください。
Issue を送るのに、事前の連絡は必要ありません。
Issue のタイトルと本文はできるだけ英語で書いてください。
- 英語に慣れていない場合は日本語を使ってください。不正確な英語では、英語話者・日本語話者のどちらにも伝わりません。
バグを Issue で報告する場合、バグを再現する為の説明、エラーの情報、環境を書いてください。
本文は明確に記述し、1 行のみの Issue を送ることは避けてください。

コードやドキュメントを DDRadar に貢献するには、ベースとなるブランチ(多くの場合 main です)から、トピック・ブランチを作ってください。(issue_999, hotfix/song-pageなど)
変更の為にテストが必要ならば、そのテストも追加または変更してください。
commit は合理的(ロジック単位)に分けてください。また目的と関係のないコードの変更は含めないでください(コードフォーマットの変更、不要コードの削除など)。
commit メッセージが正しいフォーマットであることを確認してください。commit メッセージはできるだけ英語でお願いします。
commit メッセージには、下記の修飾子を先頭につけてください。(angular.js/DEVELOPERS.mdに準じます)
- feat: 新機能
- fix: バグ修正
- docs: ドキュメントの修正のみ
- style: コードの意味を変更しない修正 (スペース・フォーマット・セミコロンなど)
- refactor: バグや機能追加ではないコード修正
- perf: コードの高速化に寄与する修正
- test: テストの追加、または修正
- chore: ビルド構成の変更やライブラリの更新など

修飾子(サブカテゴリ): コミットの概要
<ここは空行>
3行目以降に、このコミットの詳細を記述します。

大歓迎です！！
このドキュメントを含め(注: 英語版のことです)、不完全な英語を使っている箇所があります。オーナーは英語話者ではないため、そういった部分の修正を大いに歓迎します。

タイトルは変更の要約を分かりやすく書いてください。
本文には、関連する issue の番号を本文に含めてください。( ref #199 など)
まだ作業中である場合、タイトルの先頭に [WIP] を付け、Draft Pull Request で送信してください。マージ可能になったら、[WIP] を除去し、Draft を外してください。
- 作業中に main ブランチが変更された場合は、競合を解消してから [WIP] を除去してください。
- その作業を予約する意味で、まず [WIP] の付いた Pull Request を投稿しても構いません。ただし、長い間活動が見られない場合は、クローズされる場合があります。

このガイドは、MMP/CONTRIBUTING.md · sn0w75/MMP(現在リンク切れ)を参考にして作成しました。