Share
Embed
Transcript
43 slides
-
伊藤ちひろ (Chihiro Ito) 技術営業@ Red Hat OpenJDK コミッタ Quarkus コントリビュータ
日本Javaユーザグループ 幹事 : @chiroito 自己紹介 Profile 2 -
たとえば、空白を2文字追加するような修正でもOK 9 OpenJDK : Missing spaces in log message during
heap expansion https://hg.openjdk.org/jdk10/jdk10/hotspot/rev/82e8b5c2c090 -
たとえば、空白を2文字追加するような修正でもOK 10 OpenJDK : Missing spaces in log message during
heap expansion https://hg.openjdk.org/jdk10/jdk10/hotspot/rev/82e8b5c2c090 修正したコード テストコード -
12 OSSの開発者向けの内 部資料や、ユーザ向け の外部資料がある。 OSSのコード。実行する 環境によって、異なる コードが動くこともある。 コード ドキュメント コードのビルドや、コード
を修正するのに便利な ツールなどがある 開発ツール OSSのテストコード。テス トを実行する環境によっ て、実行するテスト内容 が違うこともある テストコード 貢献の対象 対象はコードだけではなく、なんでも良い -
どんな貢献ができるのか 13 種類と対象を組み合わせると、いろいろな貢献が考えられる カテゴリ 例 コードのバグ修正 既存バグを修正 自分で発見したバグを修正 テストのバグ修正 Windowsなど特定の環境で失敗するテストを修正
コード改善 不親切なエラーメッセージを分かりやすいものに改善 開発ツール改善 内部ツール(shell)をWindows Subsystem for Linuxに対応 ドキュメント改善 サンプルソースコードの不足部分を追加 -
例:ドキュメントの改善 14 Quarkus : Add more detail code and procedures
on hibernate-orm-panache doc https://github.com/quarkusio/quarkus/pull/31364 既存のドキュメントが、QuarkusとJPAに精通していないと難しかったので補足 • 省略されたインポートを追加 • 手順を守ると違う結果になるため、コメントを追記 -
例:ドキュメントの改善 15 Quarkus : Add more detail code and procedures
on hibernate-orm-panache doc https://github.com/quarkusio/quarkus/pull/31364 サンプルコードを修正 コメントを追加 -
例:WSLでIntellij IDEA対応 16 OpenJDK : idea.sh script doesn't work on
WSL 1 and 2 https://bugs.openjdk.org/browse/JDK-8250818 IntelliJ IDEAで開発するためのスクリプトが WSLでは動かなかったので修正 -
例:WSLでIntellij IDEA対応 17 OpenJDK : idea.sh script doesn't work on
WSL 1 and 2 https://bugs.openjdk.org/browse/JDK-8250818 -
例:エラーメッセージ改善 18 OpenJDK : Error messages are confusing when options
conflict in -XX:StartFlightRecording https://bugs.openjdk.org/browse/JDK-8288783 https://github.com/openjdk/jdk/pull/9302 エラーメッセージが不親切だったので、具体的にどれが問題なのかを出力するように修正 -
例:エラーメッセージ改善 19 OpenJDK : Error messages are confusing when options
conflict in -XX:StartFlightRecording https://bugs.openjdk.org/browse/JDK-8288783 https://github.com/openjdk/jdk/pull/9302 コードは省略 修正前: Duplicates in diagnostic command arguments 修正後: Options name, disk and filename can only be specified once with -XX:StartFlightRecording -
21 興味があることに対して貢献す る。 趣味で開発する人 仕事で開発する人 企業が投資しているOSSに、 その従業員が仕事として貢献す る。基本的に所属企業のビジネス に沿った貢献をする。 ユーザ
OSSを使う人 OSSに関わる人たち 基本的には、仕事で開発する人たちがユーザ向けに改善や修正をしている 本セッションの対 象者 -
22 https://openjdk.org/bylaws https://openjdk.org/projects/ 一定サイズ以上のPRを 32以上したのち、他のレ ビュアから投票 Reviewer レビュア 一定サイズ以上のPRを 8つ以上したのち他のコ
ミッタから投票 Contributor コントリビュータ Committer コミッタ 役割が定義されていることもある 一定サイズ以上のPRを 2つ以上したのち申請 Author オーサー OpenJDKの場合は、3つの役割が定義されている OpenJDKの開発者 -
25 どのOSSをやればいいの? 自分が一番興味のあるものを探してみましょう Javaに関連するOSSの例: Javaは、OpenJDK / GraalVM / OpenJ9 など
Jakarta EEは、WildFly / Glassfish / Open Liberty など フレームワークは、 Quarkus / Micronaut / Spring など ライブラリならたくさんあります -
26 どこからはじめたら良いのか? バグに遭遇することは滅多になく、遭遇しても規模感が分からないので、小さなものからはじめる ▸ 開発者に「こんな機能があったらどうか」を聞いてみる ・ ロードマップを考えて小さい機能から実装する ▸ すでにある未アサインの Issue
を修正する ・ 重要度が高いものから修正されるため、 ・ 重要度が低いものを対応してみる。 ▸ OSS が入門者向けに残してある Issue を対応する ・ OpenJDKの場合はStarterタグ -
OSS開発の流れ 27 基本的な開発の流れはどこでも一緒 1. 貢献するものを見つける 2. 再現方法や修正方針を考える 3. Fork 4.
修正&テスト 5. Pull Request 6. Review 7. Merge -
OSS開発の流れ 28 細かい流れは開発者ガイドを確認 細かいことはOSSによって違う。 開発者ガイドが提供されてることもある。 OpenJDK ▸ バグのレポートは専用のBug System ▸
1PRに複数コミットがあっても自動でsquashする Quarkus ▸ GitHubのみ ▸ 1PR=1コミットなので、push -fしまくる。 -
レビュー 29 レビューがダメな場合は、さらなるスキルアップのチャンス ▸ できたと思ったら Pull Request ▸ レビューは1回で通らないのが普通 ▸
指摘ポイントがあれば修正 ▸ きちんとコミュニケーションするのが重要 -
コミュニティ文化とやり取り 30 AIを駆使して、英語を理解し、良い感じの英語を作ってもらおう ▸ OSSの会話は「テキスト文化」 ・ 翻訳や AI を活用する ▸
感謝の気持ちを忘れない ・ 何かしてもらったら「ありがとう」を伝える ▸ Reviewで落とされてもケンカ腰にならない ・ 成長の機会として、何がダメなのかをきちんと受け取る ▸ レビュアは敵ではない。 ・ 味方になるようにコミュニケーションを取る -
いつやってるの? 33 趣味の時間は非常に貴重なので無駄にはしない 日 本 +9 am pm 0 1
2 3 4 5 6 7 8 9 10 11 0 1 2 3 4 5 6 7 8 9 10 11 趣味の時間 寝る時間 家事などの時間 仕事の時間 • 仕事をすぐに終わらせる • あとで振り返りやすいようにメモを取る • 移動時間はGitHubで調べ物、ChatGPTに相談、メモを振り返る -
有識者が活動してる時間を活用 34 時差を活用して相談する 日 本 +9 E U +1 N
Y -5 S F -8 am pm 0 1 2 3 4 5 6 7 8 9 10 11 0 1 2 3 4 5 6 7 8 9 10 11 EUと米国東海岸の人 たちとチャット 米国西海岸の人たちと チャット 趣味の時間 寝る時間 家事などの時間 仕事の時間 ここで質問を 投げて寝る -
同じことを繰り返さない 35 1回でうまくいくことなんてほとんどないが、同じ失敗はしないようにする 同じ事を繰り返したり、何をしてるか分からない時間を避ける 以下をメモしておく ▸ 調べた情報をコピペしてまとめておく ▸ 気になったAPIなどは全てメモ ▸
まずは複数の実装案を洗い出し ▸ どう実装したらどうなったか(成功?失敗?) ▸ 失敗ならなにが問題と考えられるか 実装案が尽きた場合は、上記内容をAIに渡して、新たな視点をもらう 万策尽きたら有識者に相談して、新たな視点をもらう メモの例 -
ビルドを時短する 36 十分なリソースを割り当てつつも、無駄な処理を実行しない ビルドしたいモジュールが依存するものだけを対象 mvn install -pl ビルドしたいモジュールまでのパス -am 全体のビルドが失敗した後に失敗したところからやり直す
mvn install -rf :ビルドを再開したいモジュール テストのコンパイルと実行を省略 mvn install -Dmaven.test.skip=true OSSが提供している省略オプション(例:Quarkus) mvn install -Dquickly 全CPUコアを使ってほしいので、 MAVEN_OPTS環境変数に -T 1C を設定 -
少しでも時間があったらどこでも開発できるように 37 外からでも開発の続きができるように環境を構築 Windows 11 デスクトップ WSL IntelliJ IDEA ソース
Windows 11 ノートPC IntelliJ IDEA GW GW SSH VPNサーバ Wake on LAN wakeOnLan.sh -
コミュニケーション 38 事実を箇条書きにしてAIに渡し、文を書いてもらう ▸ 事実と予想を分ける ▸ 主語と目的語を明確にする ▸ 複文にせず短文で書く ▸
能動態と受動態を明確にする あとはAIに良い感じの英語を作ってもらう。 返事がきたらAIに渡して上記を繰り返す。 GitHub AI -
質問の仕方 39 何をしてほしいのかと、その背景をきちんと伝える 以下を明確にする ▸ 相手に何を答えてほしいのか(アイディア?情報源?) ▸ 自分が何をしようとしているのか ▸ 自分の理解
▸ 自分がすでに何をして、なにがダメだったのか ▸ 複数の選択肢がある場合は、それぞれのメリデメ -
まとめ 42 すごく楽しいので、今日からぜひやってみてください! 小さなPRが世界を変える理由: - 1人の開発者が修正した1行が、何千人のユーザーを救う。 - OSSは“1行の善意”の積み重ねで成り立っている。 最初の一歩のおすすめ: A.
使っているOSSのドキュメントで気になる点をメモ B. 初心者向けタグが付いたissueを探す C. 環境によるissueを探す