From bc17eef3409d3e6d81f095c737462357c958cd0d Mon Sep 17 00:00:00 2001 From: yu23ki14 Date: Sun, 29 Oct 2023 14:17:08 +0900 Subject: [PATCH] Draft contributing.md --- CONTRIBUTING.md | 56 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 56 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..a4fe0dd --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,56 @@ +# 貢献の仕方 + +コントリビューターの皆様、本プロジェクトにご参加いただきありがとうございます。 +本プロジェクトの開発に参加してくださる方に対して、参加方法をお伝えします。 + +## Issue へのコメントや Pull Request について + +- Issue へのコメントはご自由にしていただいて構いません。新しい質問や提案なども受け付けます。 +- Issue を追加する場合、すでに同様の Issue が存在するかどうかを検索してから作成してください。 +- Pull Request を送る場合、必ず対応する Issue 番号を記載してください。単独の Pull Request は作業範囲や対応箇所がわかりにくく、レビューが複雑になるので受け付けません。 +- 頂いた提案については必ず反映できるとは限りませんのでご了承ください。 +- アーキテクチャ、レイアウト、文言等の大幅な変更など、基盤に関わるものについては、関係者の確認が必須です。採用される可能性もあまり高くないことをご了承ください。 +- good first issue / help wanted / bug を優先して対応していただけると助かります。 + +## プロジェクトのコミュニケーション方法 + +OWND プロジェクトでは matrix にてコミュニケーションを取っています。 +OWND プロジェクトの matrix サーバーに入っていない場合、[こちらからご参加ください](https://matrix.to/#/!EdKfOXCYPSFCXmxTqw:matrix.org?via=matrix.org)。 + +matrix の初期設定については[こちらを参照ください]()。 + +## 参加にあたって + +- 本プロジェクトに参加するにあたっては、[Code of Conduct (行動規範)]()もご確認ください。 +- プロジェクトの概要については[こちらを参照ください](https://github.com/OWND-Project/.github/blob/main/profile/README.md)。 +- 自分ができそうな Issue に誰もアサインされていない場合、Issue に「やります！」等、コメントしてから開発をはじめてください。Issue へのアサインをさせていただきます。 +- 取り組みはじめたものの、1 週間以上作業から離れそうな場合は、他の人が作業を引き継げるように[Draft Pull Request](https://qiita.com/tatane616/items/13da1b6797a7b871ad58)にて進捗共有をお願いします。 +- 1 週間以上更新されない Issue については、当方でアサインをはずさせていただくことがあります。 +- Issue に関連した質問や提案は、matrix よりも Issue 内のコメントを活用して、あとから追いやすくしましょう。 + +## 開発に関する情報 + +開発を始める際はまずリポジトリを自身の github アカウント上にフォークしてください。フォークしたリポジトリにコミットを行い、作業完了次第 **staging ブランチ** に向けて Pull Request を出してください。 + +### ブランチ運用 + +各リポジトリのブランチ運用は以下のルールを基本とします。 + +本番環境、テスト環境 + +| 名前 | 用途 | +| ------- | ----------------------------------------------------------------- | +| main | 本番環境にデプロイされる最新バージョン | +| staging | テスト環境にデプロイされるバージョン。Pull Request を受け付ける。 | + +開発時 + +| Prefix | 用途 | 例 | +| -------- | ------------------------------------------------------ | -------------------------- | +| feature/ | 機能拡充や UI・UX の改善など新規機能の追加に関わるもの | feature/mypage_credentials | +| bug/ | 既存機能のバグ修正に関わるもの | bug/issuing_credential | +| chore/ | 変数名やドキュメントのタイポ修正など | chore/fix_mypage_typo | +| docs/ | ドキュメントの作成や更新など | docs/local_dev_env | +| dex/ | CI・CD の構築など開発者体験に関わるもの | dex/client_deployment | + +本ドキュメントの改善、提案も歓迎しております。