このプロジェクトの改善にご協力いただきありがとうございます！ 🎉
このドキュメントは、プロジェクトにコードを貢献したい方のためのガイドラインです。バグを報告したり、機能リクエストを作成したり、コミュニティの一員として他のユーザーを支援するなど、貢献する方法は他にもあります。
- このプロジェクトの概要や目的をここに記載してください。
- 本プロジェクトは、開発者の方からのコントリビュートを募集しています！ぜひ一緒に日本のデジタル民主主義を前に進めましょう！
- 開発に参加する方は、GitHubからリポジトリをクローンして作業します。
- プロジェクトについてのやりとりは、Issue、Pull Request、またはコミュニケーションチャンネルで行ってください。
- コントリビュートにあたっては、本リポジトリのrootディレクトリにあるCLA.md（コントリビューターライセンス）へ同意が必要です。
- 同意する手順は、Pull Requestのテンプレートに記載があります。
レビュアー向けのガイドラインはこちら
- Issueはどなたでも起票いただけます。ツール利用時に感じた改善点やバグについてぜひIssueを作成してください
- 解決されると自分に役立つIssueには👍リアクションを付けてください
- リアクションの件数はIssueの優先度を決める重要な指標となります
- 重複作業を避けるため、Issueに取り組む際はご自身をassigneeに指定してください
/assignコメントを記載するとIssueのassigneeとして登録されます- 権限の関係で一部のコントリビューターを除きアサイン機能が使えないため、このような運用をしています
- 割当解除には
/unassignコメントをご利用ください
- 初めての貢献に適したタスクにはgood first issueラベルが付いています
数行以上のコードを提供する場合は、実装に着手する前に以下のステップをお願いします：
- 関連するIssueがない場合は、まず新たにIssueを作成してください
- 実装計画を投稿し、メンテナや他の開発者からの賛同（リアクション）を得てから着手してください
- 特に、軽微なバグやUIの修正ではなく、新機能の追加や大規模なアーキテクチャの変更を行う場合には、メンテナーのリアクションを得てから開発に着手してください
このプロセスにより：
- 同じ問題への重複した取り組みを防止できます
- プロジェクトの方針と一致した実装となります
- API、UI、アーキテクチャの変更が十分に検討されます
注意: 事前承認なしに新機能を追加するPRはマージされにくい傾向があります。新機能追加にはAPI設計や将来の保守など多くの負担が伴うためです。
- コードをコミットする前に、コードのフォーマットを整えてください
- 最新の
mainブランチからフィーチャーブランチを作成してください - プルリクエストを作成し、変更の詳細を説明してください
- コードレビューを受け、必要に応じて変更を加えてください
- メンテナーのapproveを得ると、変更がマージされます
上記のうち1名がapproveした場合にmainへのマージを行います。メンテナーは将来的に増やしていく予定です。
本リポジトリへのコントリビュートには、コントリビューターライセンス契約（CLA）に同意することが必須です。Pull Requestを提出する際に、テンプレートに従ってCLAへの同意を示してください。
質問や問題がある場合は、Issueを作成するか、プロジェクトのコミュニケーションチャンネルで質問してください。コミュニティのメンバーが喜んでお手伝いします。
ご貢献ありがとうございます！