背景
- fairseq1を使っていたらバグを見つけた
- なんとか原因を突き止めて修正できた
- プルリク送りたい
Contributing guideline
ここに大体書いてありますので、公式の情報を見たい方はこちらからどうぞ。
https://github.com/pytorch/fairseq/blob/master/CONTRIBUTING.md
流れ
- Facebook OSS の CLA に登録
- issue を作成
- fairseq を fork
- fork したリポジトリをクローンし、ブランチを作成
- コードを修正
- コミット＆プッシュ
- githubからプルリクエストを作成
詳細
1. Facebook OSS の CLA に登録
Facebookのオープンソースコミュニティのコントリビューターライセンス契約。
まずはこれに登録する。
プルリク送ったあとでも問題ないらしい。
リンク： https://code.facebook.com/cla
2. issue を作成
直接プルリクを作成しようとするとこんな感じのデフォルトメッセージが表示される。
issue で議論しておいたほうがいいことが書いてあるので、issue を立てる。
issue はここから立てられる。
New issue をクリックすると、次の4つから選べるので、 Bug Report の Get started をクリック。
- 🐛 Bug Report
- Submit a bug report to help us improve
- 📚 Documentation/Typos
- Report an issue related to documentation or a typo
- 🚀 Feature Request
- Submit a proposal/request for a new feature
- ❓ Questions/Help
- If you have questions, please first search existing issues and docs
Bug Report の場合、次の項目がデフォルトで作成されるので、埋めていく。
- Bug
- To Reproduce
- Code sample
- Expected behavior
- Environment
- Additional context
それぞれ、下記のように書いた。
Bug: バグの内容を簡潔に2文程度で
To Reproduce: 実行した内容とコマンド
Expected behavior: 期待した挙動と実際の挙動を、実際の出力を添えつつどこが問題か分かるように
Environment: 必要そうな環境だけ
Additional context: 今回はPRを自分で作成する前提だったので、後でRPを送るよと
3. fairseq を fork
ここをクリック。
そうするとリポジトリが自分のアカウントにコピーされて、
https://github.com/<user name>/fairseq
ができる。
リンク: https://github.com/pytorch/fairseq
4. fork したリポジトリをクローンし、ブランチを作成
git clone https://github.com/<user name>/fairseqgit branch issuegit checkout issue
ブランチは作成してもしなくても大丈夫かもしれないが2、ガイドラインには書いてあるのでやっておく。
ブランチ名は何でもいいと思う。
5. コードを修正
バグ部分を修正。
今回は量の少ない修正だったこともあり、コーディング規約などはきちんと調べずに書いた。
スタイルは既存のコードを参考にしつつ。
問題があればレビュー時に修正してもらえるだろうという目算。
6. コミット&プッシュ
コードをgitでコミットしてプッシュ。
コミットメッセージは、PR作成時にデフォルトのタイトルと本文になるっぽいので、ここで修正内容がちゃんと分かるように書いておくと良いかもしれない。
7. githubからプルリクエストを作成
ここから。
New pull request をクリックすると、変更がプッシュされている場合は、Create pull request をクリックできるようになるので、master に送りつける。
デフォルトのプルリクのメッセージが表示されるので、編集していく。
Before submitting の欄は、今回はissueは立てたけどまだ議論されていないので、2番目の Did you read the contributor guideline? にだけチェックを付けておいた。
What does this PR do? の欄で、(issue)となっている箇所を事前に立てた issue の番号に変えると、自動的に関連付けられる。
こんな感じで、issueの方に勝手にプルリクのリンクが付く。
github便利。
プルリクを送信すると、自動的にテストが行われる。
今回はテストが一部通らなかったが、そもそも master がテストに通っていないので、仕方ない。（commitをさかのぼってみてみたら、CIの種類を追加した当時から一度も通ってないっぽい。）
以上。
何かあれば通知が来るようになっているので、座して待つのみ。
追記：4日後に無事にマージされた 