だいぶ遅めのご挨拶ですが、明けましておめでとうございます。
長めのお休みを取っている間に、TiDBのドキュメント改善イベントの TiDB Docs Dashが始まってしまっていました。
あと残り一日しかありませんが、このイベントとイベントへの参加方法について紹介します。GitHubでのpull requestの送り方などは同じですので、イベント後もTiDB Docsの更新に役立てて頂ければと思います。
TiDB Docs Dashとは？
TiDB Docs DashはTiDBのドキュメントに関する様々なIssueの解消を皆で競って実施しようというものです。このイベントのためにIssueリストが整理されており、このIssueを手伝ったり修正のPRを送ったりするとポイントがもらえ、優秀者には豪華賞品が出るようです。期間は 1/12の16:59 JSTまでとなっています。
参加方法
こちらにIssue Listがあります。今回対象のドキュメントは英語版と中国語版がありますので、得意な方のIssueを参照してください。
やってみたいと思ったIssueの詳細画面を開いて、コメント欄で /assign と書いたらそのIssueの担当者となれます。
Issueにはカテゴリがあり、
- Debug - ドキュメントに記載のチュートリアルや設定を試して、実際にその通り動くか検証する。問題あれば修正してPR.
- Translate - 中国語/英語の翻訳を手伝う
- Enrich - 該当ドキュメントに加筆する
- Resolve existing Document issues - 既存のドキュメントの問題を修正する。既に問題ありと分かっているのですが修正が追いついていないドキュメントを直します。
- Improve documentation CI/HTML/PDF - ドキュメントの生成パイプラインの修正。
もちろん、これ以外にも問題があればそちらを修正しても問題ありません。Typoなどもどんどん見つけましょう！
商品
- 参加した全ての人のGitHubプロファイルに記載できるデジタルバッジ
- その他商品はイベントサイトを確認してください。
PRの送り方
さて、実際にdocsを修正した後にPRはどう送ったらいいのでしょうか。詳細なやり方は Contributer Guide に記載がありますが、ここではかいつまんで説明します。
-
CLA Contributer License Agreementに同意する
ライセンス条項を読んで最後の方にある同意ボタンを押します。 -
[docsリポジトリ]((https://github.com/pingcap/docs)をForkする
-
ローカルにforkしたリポジトリをcloneする
git clone git@github.com:$user/docs.git # "$user"を自分のgithub idで置き換え cd $working_dir/docs git remote add upstream git@github.com:pingcap/docs.git # Adds the upstream repo git remote -v # 確認 -
ブランチを作成
上流の最新版においついていることを確認して、ブランチを作成します。cd $working_dir/docs git fetch upstream git checkout master git rebase upstream/master git checkout -b <新しいブランチ名> -
修正を加えてコミット
コミットメッセージのスタイルガイドもあります。git status # Checks the local status git add <file> ... git commit -m "commit-message: update the xx" -
ブランチが上流と同期していることを確認してpush
git fetch upstream git rebase upstream/master git push -u origin <新しいブランチ名>pushした後にPull Requestへのリンクが表示されると思うので、pull requestを作成します。
-
Pull Requestを送る
Pull Requestを送る際にブランチを指定しますが、TiDBの特定のバージョンに関する記載出ない限りmasterを指定すればOKです。
Pull Requestの依頼メッセージにはテンプレートが差し込まれているので、テンプレートに沿って記載してください。
是非チャレンジしてみてください！