Draft contributing.md #3
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
yu23ki14
commented
Oct 29, 2023
| - Pull Request を送る場合、必ず対応する Issue 番号を記載してください。単独の Pull Request は作業範囲や対応箇所がわかりにくく、レビューが複雑になるので受け付けません。 | ||
| - 頂いた提案については必ず反映できるとは限りませんのでご了承ください。 | ||
| - アーキテクチャ、レイアウト、文言等の大幅な変更など、基盤に関わるものについては、関係者の確認が必須です。採用される可能性もあまり高くないことをご了承ください。 | ||
| - good first issue / help wanted / bug を優先して対応していただけると助かります。 |
There was a problem hiding this comment.
優先対象のものとして、good first issue、help wanted、bug の3種類のラベルをひとまずおいていますが、他に使っているラベルなどありましたらそちらを教えていただけると嬉しいです。
| OWND プロジェクトでは matrix にてコミュニケーションを取っています。 | ||
| OWND プロジェクトの matrix サーバーに入っていない場合、[こちらからご参加ください](https://matrix.to/#/!EdKfOXCYPSFCXmxTqw:matrix.org?via=matrix.org)。 | ||
|
|
||
| matrix の初期設定については[こちらを参照ください]()。 |
There was a problem hiding this comment.
初期設定について書いてあるもので、外部のサイトでもよいので良いものがあれば教えていただけると嬉しいです。
There was a problem hiding this comment.
matrixの初期設定について分かりやすいものが無いため、作ろうということになりました。
Issue #5 として登録いただきました。
|
|
||
| ## 参加にあたって | ||
|
|
||
| - 本プロジェクトに参加するにあたっては、[Code of Conduct (行動規範)]()もご確認ください。 |
There was a problem hiding this comment.
Code of Conductが出来次第リンクいれます。
|
|
||
| ## 開発に関する情報 | ||
|
|
||
| 開発を始める際はまずリポジトリを自身の github アカウント上にフォークしてください。フォークしたリポジトリにコミットを行い、作業完了次第 **staging ブランチ** に向けて Pull Request を出してください。 |
There was a problem hiding this comment.
一旦stagingブランチに向けるようにしていますが、別でも問題ありません。
| | 名前 | 用途 | | ||
| | ------- | ----------------------------------------------------------------- | | ||
| | main | 本番環境にデプロイされる最新バージョン | | ||
| | staging | テスト環境にデプロイされるバージョン。Pull Request を受け付ける。 | |
There was a problem hiding this comment.
基本的に以上2つを親としてコードを集約していくようになるのかと想像していますが、他の名前や運用方法になっている場合はおしえてください。
| | bug/ | 既存機能のバグ修正に関わるもの | bug/issuing_credential | | ||
| | chore/ | 変数名やドキュメントのタイポ修正など | chore/fix_mypage_typo | | ||
| | docs/ | ドキュメントの作成や更新など | docs/local_dev_env | | ||
| | dex/ | CI・CD の構築など開発者体験に関わるもの | dex/client_deployment | |
There was a problem hiding this comment.
以上5つの基本的なシーンごとでわけてみました、他に追加したほうがよいものなどあれば教えてください。
|
LGTM! 開発関連のブランチ名については、後日現在開発を行っているメンバーとも相談していきたいと思います。 |
Closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
貢献の仕方についてのドキュメントの草案を作成しました。
#1