ドキュメントから始めるOSSコントリビュート

タグ oss oss活動
スライド概要

2021/08/18 OSS LT会の発表資料
https://rakus.connpass.com/event/218573/

profile-image

takaram

@takaram

作者について:

PHPer, Rubyist

スライド一覧
1人がいいね!しています
radiocat Yuka Sato
シェア
埋め込む

作成日

2021-08-18 20:32:05

各ページのテキスト

1. ドキュメントから始める OSSコントリビュート 2021.08.18 OSS LT会

2. 自己紹介 名前:荒巻拓哉 所属:株式会社ラクス メールマーケティングサービス 言語:PHP, JavaScript, Ruby Twitter:@takaram71 GitHub:takaram 開発

3. OSSにコントリビュート したい!

4. OSSコントリビュートの目的 ● バグ修正の必要に迫られて ● OSSへの恩返し ● {社内での, 就職・転職時の}評価を上げるため ● なんかカッコいいから

5. ハードルが高い? ● コードが複雑で手が出せない😫 ● バグってたらどうしよう……😱 ● 英語わからん🤪

6. 低いハードルから 越えてみる

7. ハードルが高い? ● コードが複雑で手が出せない😫 ● バグってたらどうしよう……😱 ● 英語わからん🤪 ⇒ 日本語のドキュメントならいけそう!?

8. PHPの公式マニュアル (日本語版)にPRを 送った話

9. https://www.php.net/manual/ja/language.basic-syntax.phptags.php

10. PHP公式マニュアル ● 英語版をもとに各国語に翻訳されている ● DocBook形式で記述 ○ ● XMLで技術文書を書くためのフォーマット GitHubでソース管理 ○ 日本語版:https://github.com/php/doc-ja

11. きっかけ 公式マニュアルを見ていると 「ん?なんか説明が変だな」と気づく → 英語版と見比べると誤訳っぽい

12. きっかけ 公式マニュアルを見ていると 「ん?なんか説明が変だな」と気づく → 英語版と見比べると誤訳っぽい → 自分で修正してみよう!

13. 実際の流れ 1. リポジトリのドキュメントの内容を確認 ○ README.md ○ CONTRIBUTING.md 2. 修正対象のファイル・行を探し当てる ○ PHPマニュアルの場合、ファイル数が膨大なのでGitHubの検索で探す

14. 実際の流れ 3. リポジトリをフォーク 4. ローカルにclone 5. 修正してcommit, push 6. Pull Request作成

15. 実際の流れ 3. GitHubのUIからファイルを編集 ○ 自動でリポジトリがフォークされます

16. 実際の流れ 4. 修正内容の説明を記入して Propose changes をクリック

17. 実際の流れ 5. Pull Request作成

18. 実際の流れ 6. CIが通っていることを確認 7. メンテナのレビューを気長に待つ

19. 実際の流れ 8. 問題がなければマージされる🎉

20. まとめ ● OSS活動の最初のステップとしてのドキュメント ○ 修正しやすい ○ 日本語ドキュメントなら英語不要 ○ PHPのような大規模OSSでも比較的気軽にチャレンジできる