Hello, OSS

OSS (Docker docs) にコントリビュートしてみた

目次

Docker docs の Python + K8s チュートリアルに不備があったので修正した．

Python guide 4: Invalid port value · Issue #21320 · docker/docs

Is this a docs issue? My issue is about the documentation content or website Type of issue Information is incorrect Description Hello, and thank you for providing such valuable documentation. As th...

github.com

流れ

• Docker docsのチュートリアルをやる
• 期待した動作をしない
• 原因究明
• 解決
• これOSSコントリビュートチャンスなのでは？！
• ローカルに環境構築する
• OSSのマナーを調べる
• issueを立てる
• PRを出す

— 翌日（時差）—

• issueでreviewerとやりとり
• PRを修正
• PRがmergeされる
• issueがcloseされる

Writing

• 日本語でdraftを作成
• DeepLで 日本語 → English
• DeepL Writeで（英語の表現）調整
• ChatGPTで（OSSのマナーなど）調整
• 人間の目で（文脈，固有名詞など）最終確認

論文を読む時など一方的に情報を受け取る場合は，ある程度適当に読んでいた．
しかし，今回のように相手がいて，コミュニケーションを取る場合は，まずReadingで正しく理解し，Writingで正しく相手に伝えるということを意識する必要があった．
微妙なニュアンスの違いを意識することは大変だったが，良い勉強になったと思う．

おわりに

ずっとOSSに憧れがあり，いつかOSSコントリビュートしてみたいと思っていた．
たまにgood first issueなどを調べたりしていたが，既に誰かが取り組んでいるものばかりで，なかなかチャンスが無かった．
今回，ようやく目標を達成できてとても嬉しい．
この調子で，今度はソースコードを修正するタイプの貢献もしていきたい．

謝辞

issue, PRのreviewをしてくださった Docker Inc. の David Karlsson (@dvdksn) さん，ありがとうございました．

Thanks to David Karlsson (@dvdksn) of Docker Inc. for reviewing the issue and PR.
I really appreciate you.

参考文献

• 貢献したdocs: https://docs.docker.com/guides/python/
• docsのGitHub repo: https://github.com/docker/docs/tree/main/content/guides/python
• issue #21320: https://github.com/docker/docs/issues/21320
• PR #21327: https://github.com/docker/docs/pull/21327