Kubernetesの日本語ドキュメントにコントリビュートしてみた時のメモ

これは何

Kubernetes の日本語ドキュメントにコントリビュートしてみたので、そのメモ。

Forkとかgit rebaseとか調べながらやったので、やったことをただ残しておく。

たぶんいろいろやり方はあるんだと思う。あと不要なことやってそう。

背景

Kubernetesのプロジェクトに初めてコントリビュートしてみたい人のためのおすすめIssueがいっぱい立ち上がりました。あんまり詳しくないよって人でも大丈夫なくらいの内容です（Docの差分を翻訳して更新するやつ）

興味がある方は /assign のあとにお気軽にプルリクどうぞhttps://t.co/scRk5PcD3w

— inductor (@_inductor_) 2021年2月15日

というツイートをたまたま見て、良い機会なのでやってみようと。

やったこと

事前

• issueをよく読む

  github.com

  • 目的はオリジナル(英語)に合わせて日本語版をアップデートすること
  • 特にどのブランチから開始すべきなのか（今回で言うdev-1.18-ja.2）

修正

• リポジトリを自分のところにForkする
  対象のリポジトリに行ってFork押せばよい。ブランチも含めてまるっと来る。
  今回で言えば kubernetes/website から。

• ローカルに clone
Forkしてきた自分のリポジトリを普通にgit cloneする。

• ブランチを切る
  対象となるブランチから、ローカルで修正のためのブランチを切る。
  この場合はdev-1.18-ja.2からブランチを切った。

• 修正作業
  普通にローカルで修正する。
  

• 動作確認
  ローカルで動かして確認が可能。
  公式のRunning the website locally using hugo をそのままやったら確認できた。

• 自分のローカルでpushまでやる
  git commit -am 'コメント'
git push origin [修正してる自分のブランチ]

PR出すまで

• Forkしたリポジトリを本家に追従させる
  upstreamって名前にした。
  git remote add upstream https://github.com/kubernetes/website

• PR出す前にFork元のmasterの更新を取得しておく
  git checkout master
git pull upstream master
git push origin master

• git rebase
  

  • ローカル修正用のブランチに変更
    git checkout [修正してる自分のブランチ]
    
  • rebaseする
    git rebase master
  • push
git push -f origin [修正してる自分のブランチ]

• PR出す
  Forkしてきた自分のリポジトリに行く。
  ブランチ切り替えた上でpull requestを押す。
  ブランチは良く確認した上で、PRを出す。

PR上でのやり取り

• PR上でレビュアから「ここは直さなくてよいのでは？」とコメントもらい、対応した。

参考にさせていただいたもの

zaki-hmkc.hatenablog.com

ありがとうございます！