Contributing Guide (貢献方法)

1. コントリビューターの役割

コントリビューターは以下の分野で貢献が可能です：

• バグ修正: 現在のコードベースでの不具合を修正
• 新機能の提案と実装: プロジェクトに新しい機能を追加
• ドキュメントの改善: コードやプロジェクトのドキュメントを改善

2. Issue管理

• 貢献したいタスクを探す際は、GitHubのIssueタブ を確認してください。
• 以下のタグを活用しています：
  • good first issue: 初心者向けのタスク
  • help wanted: 特に支援が必要なタスク
  • docs: ドキュメントの追加や修正が必要な場合

3. 開発フロー

コントリビューターは以下の手順で開発を進めてください：

1. Issueを確認・選択

   • 貢献したいタスクが未登録の場合、まず新しいIssueを作成してください。

2. ブランチの確認と作成

   • ブランチを作成する前に以下を確認してください：
     • Discordの#開発報告に開発に取り組んでいる人が存在しない
     • 開発に取り組んでいる人が存在していても、1ヶ月以上進捗がない
   • 条件を満たしている場合、Discordの#開発報告でIssueの開発をしたい旨とGithubのアカウント名を申告後、返信があってから、新しいブランチを作成し、開発してください：
     • 新機能の場合: feature/#[Issue番号]
     • 不具合修正の場合: fix/#[Issue番号]
     • ドキュメント改善の場合: docs/#[Issue番号]

3. 開発期間

   • 原則、Issueに関連する実装は、1ヶ月以内に完了してください。
   • 期間内に完了できない場合は、Discordで進捗を報告してください。

4. Pull Request (PR)の作成

   • PRのタイトルとコミットメッセージはConventional Commits の形式に従ってください。
   • 実装内容を明記した説明を記載してください。
   • 必要に応じて、スクリーンショットやログを添付してください。

5. マージ

   • PRが完成していれば、メンテナーがdevelopブランチにマージします。

4. ドキュメント改善のガイドライン

• ドキュメント改善のためには以下のような内容を含むことができます：
  • READMEの更新: セットアップ手順や機能説明の追加・修正
  • コードコメントの追加: コード内の理解を助けるコメントの追加
  • Wikiやチュートリアルの改善: より分かりやすくするための内容追加・修正
• ドキュメント改善タスクはdocumentationタグを使用して管理されます。
• ブランチの命名はdocs/#[Issue番号]とします。

---

ご不明点がありましたらお気軽にDiscordの開発カテゴリーにある #質問 でお願いします！