.NET 開発基盤部会 Wiki
目次 †
概要 †
Githubを使用しているプロジェクトにおける運用の中で気が付いたこと。
Gitについて理解が必要。 †
Pull Request関連 †
一覧 †
Filters †
Filtersを実行できる。
既定で以下が適用されている。
is:pr is:open
- ソート
ソートを選択してソートできる。
- Newest
- Oldest
- Most commented
- Least commented
- Recently updated
- Least recently updated
多分、Filters で組み合わせできると思う。
Label †
Issueと同様にLabelを設定できるが、
Pull requestはIssueに対応付けるので、
Pull request側にLabelを張らない事が多い。
Milestone †
Issueと同様にMilestoneを設定できる。
Pull Requestの送信方法 †
Repository間 †
- Fork元のRepositoryに対してPull Requestを送信することができる。
- Public RepositoryとPrivate Repository間ではPull Requestを送信できない。
Branch間 †
- Branch元のBranchに対してPull Requestを送信することができる。
- Branchする時は、Branch元のブランチを選択・表示させた状態で、
BranchのDropDown?のFind or create a branchに存在しないBranchを入力する。
Pull Requestの作法 †
CONTRIBUTING.mdに記載されている貢献(コントリビュート)の作法に従う。
featureブランチ †
- Pull Requestを作成にはfeatureブランチを作成する必要があります。
- featureブランチの修正後、都度Pull Requestを送ってレビューを依頼します。
- featureブランチに異なるIssue(問題やエンハンス)のタスクの修正を混ぜてはいけません。
- 複数のfeatureブランチ
- Pull Requestのサイズが大きくなりレビューが困難になる場合は、
- 複数のfeatureブランチを作成し、複数のブランチ間のPull Requestを送信します。
- 複数のブランチ間のPull Requestに対して、レビューを行います。
- そのブランチで、複数のPull Requestをマージして束ね、
- Fork元のブランチに集約されたPull Requestを送付します。
- 集約されたPull Requestには、レビューの為の個々のPull Requestのリンクを張ります。
Pull Requestのサイズ †
- レビューし易いサイズに分割
Pull RequestのレビューのためにPull Requestのサイズを小さくします。
- 1 Issue 1~n Pull Request
1つのPull Requestの中に複数のIssue(問題やエンハンス)のタスクが存在する場合、
レビューがボトルネックになるので、問題やエンハンスのタスク毎にPull Requestを作成します。
- 不要な修正もコミットしないで下さい。
- IDEやEditorによりインデントが変更されるような修正。
- 誤った修正を再度修正するような修正(スラッシングを避ける)。
Pull Requestの送信前 †
Pull Requestの送信前に(若しくはPushする前に)、
Pull Requestを送る先のブランチをPullする。
Pull RequestでIssueをClose †
Pull Requestの送信後 †
Pull Request送信後の送信元リポジトリの更新 †
Pull Request送信後に送信元リポジトリを更新した場合の動作は、
- Pull Requestに更新が反映される。
- Files changedに結果が反映されるには時間差がある。
となります。
従って、
- そのまま、mergeしてもよし、
- 急いでいるときはCloseして、再度、Pull Requestを投げてもよし。
です。
参考 †
Issue関連 †
一覧 †
Filters †
Pull Requestを同様にFiltersを実行できる。
Label †
- 設定
IssueにはLabelを設定できる。
- 追加
また、カスタムLabelを追加して使用できるらしい。
Milestone †
Scheduleを設定して、Issueに関連付ける事ができる。
フロー †
採用するフローは、CONTRIBUTING.mdに記載しておくと良い。
https://github.com/OpenTouryoProject/OpenTouryo/blob/develop/CONTRIBUTING.md
git-flow †
Markdown †
root †
ルートのフォルダに書くMarkdown
license.md †
ライセンスについて記述する。
https://github.com/OpenTouryoProject/OpenTouryo/tree/develop/license
CONTRIBUTING.md †
貢献(コントリビュート)の方法について記述する。
https://github.com/OpenTouryoProject/OpenTouryo/blob/develop/CONTRIBUTING.md
README.md †
リードミーを記述する。
https://github.com/OpenTouryoProject/OpenTouryo/blob/develop/README.md
一覧 †
Issue †
https://github.com/OpenTouryoProject/OpenTouryo/issues
を記載する。
Pull Request †
https://github.com/OpenTouryoProject/OpenTouryo/pulls
Pull Requestの内容やレビューの指摘の内容を記載する。
その他 †
Gist †
その他 †