このプロジェクトへのコントリビュート方法についてのガイドです。
- バグについては、Github issuesで管理します
- issueを作成する前に、正しいリポジトリかを確認してください
- Openになっているissueで、すでに報告されていないかを確認してください
- バグを報告する場合は、可能な範囲でissue templateの内容に沿って記載してください
- サンプルコードやエラーメッセージ内にAPIキーや個人情報などが含まれていないか確認してください
GitHub Flow に従って開発をします。
master branchから branchを切ります。ブランチの命名規約は （feature or bug）/(名詞または単語）#(issue番号)例bug/showedit#20
ブランチを切ってコミットを始めたら、まずWIPのPullRequestを作成します。 WIPのPullRequestはまだレビューの必要のない作業中のPullRequestで、現在の作業の進捗状況をdiffベースで共有するために作成します。
WIPのPullRequestではWIPラベルをつけ、変更内容に関連するissue(必ずAssigneeを自分に設定すること)を紐付けた上で、実装する内容などを書くようにしてください。可能な範囲でpull request templateの内容に沿って記載してください。
修正は定期的にGitHubにpushしましょう。差分や進捗、課題を共有できます。pushすることで、CIによるテストと静的解析が走ります。修正したらできる限りテストを書き、CIが通ってからレビュー依頼・masterへのマージを行うようにしてください。(但し必須ではない)
- レビューする段階になったら、
WIPラベルを外します。 レビューしてのラベルをつけます。レビューのポイントをコメントに書いてレビュー依頼をします。- ３名以上を指定してレビュー依頼をします。この際、@tsu-nera + もう二人以上を指定します。
- レビューアーはレビュー後に問題なければ
(名前)-LGTMラベルをつけます。
- レビューアーは、Review Changedボタンに comment or approve を選択して、コメントを残す。Request Changedはつかわない。再修正を求めるのは快くないし、お互いの都合をあわせることによって開発のスピードが止まるかもしれないので。あくまで、アドバイスや褒めあうことによってよりよいコードの品質を目指すことが目的。また、知識を共有して楽しく学びあうことが目的
- PullRequestする際はテンプレートを用いる。(自動に出る)
@tsu-neraともう一人の計2人のLGTMが出たら、Merge pull requestボタンを押して masterへのマージをします。マージが完了したら、作業していたブランチは削除します。
PRでReviewのLGTMが二人以上出ている場合で特段のコメントがない限り24時間後にはmergeします。
コメントをつけてissueをクローズします。commit-messageによる自動クローズ機能もありますが、手動でクローズすることにします。（確認のため）