初めてのOSSコントリビュートに挑戦したら、既に該当機能が存在していた件について

20231215

Transcript

1. 初めての OSSコントリビュート に挑戦したら、
 既に 該当機能 が 存在 していた件について
 
 2023/12/15
 
 (株)インフィニットループ　
 サーバーサイドエンジニア　kerokero

2. 発表の前に……

3. 発表の前に……
 ・今回の発表は9月に行われたPHPカンファレンス沖縄 2023でのLT発表内容にいくつか情報を付け加えたものに なっています ・PHPer向けの内容だったものですが、OSSコントリ ビュートに内容を寄せたものへと少し変更しました ・発表中に出てくるLaravelというのはPHPのフレームワー クです 　※pythonでいうDjango, RubyでいうRailsみたいなものです。

4. 今回の発表の対象者
 ・ laravel/frameworkにPRを送ってみたい人

5. 今回の発表の対象者
 ・ laravel/frameworkにPRを送ってみたい人
 ・ PHPやその周辺技術に貢献したい人
 

6. 今回の発表の対象者
 ・ laravel/frameworkにPRを送ってみたい人
 ・ PHPやその周辺技術に貢献したい人
 ・ OSSコントリビュートに興味がある初心者

7. 今回の発表の対象者
 ・ laravel/frameworkにPRを送ってみたい人
 ・ PHPやその周辺技術に貢献したい人
 ・ OSSコントリビュートに興味がある初心者
 < 難しそう……
 OSSとは、ソースコードの改変や再配布が自由に認められている無償のソフトウェアです。
 よく知られているOSSにはJavaやPHP、Pythonなどがあります。 ※
8. Agenda
 1.　軽い自己紹介
 
 2.　laravel/framework にPRを出そうとした経緯
 
 3.　実際にPRを出してみた
 
 4.　それって〇〇と何が違うんだい？
 
 5.　反省点・良かった点・感想

9. Agenda
 1.　軽い自己紹介　　　　　　　　　　
 
 2.　laravel/framework にPRを出そうとした経緯
 
 3.　実際にPRを出してみた
 
 4.　それって〇〇と何が違うんだい？
 
 5.　反省点・良かった点・感想

10. どうも、kerokero です。

11. 22卒　自称青魔道士系エンジニア 
 （株）インフィニットループ 
 kerokero ・北海道の 札幌 生まれ、札幌 育ち
 ・水産→数学(非情報系)→2022年4月にIL入社 　 ・最近の趣味は 絵を描く ことと ストリートファイター6 です
 ・担当領域は サーバーサイドのアプリ・インフラ実装(PHP, AWSなど) です 

12. Agenda
 1.　軽い自己紹介　　　　　　　　　　
 
 2.　laravel/framework にPRを出そうとした経緯
 
 3.　実際にPRを出してみた
 
 4.　それって〇〇と何が違うんだい？
 
 5.　反省点・良かった点・感想

13. というわけでいきなり本題ですが……

14. というわけでいきなり本題ですが……
 Laravel の アップグレード をしようとしました
 

15. Laravel の アップグレード をしようとしました
 
 というわけでいきなり本題ですが……
 ・チームで使っているLaravelのバージョンを9から10に移行することに
 
 ・この作業は kerokero が担当することになった
16. すると……

17. psalm/plugin-laravel もアップデートされてた‼
 すると……
 ・Psalmプラグインの更新により、コードの静的解析の結果が変わった

18. psalm/plugin-laravel もアップデートされてた‼
 すると……
 ・Psalmプラグインの更新により、コードの静的解析の結果が変わった
 < なんとかして、大幅に実装を変えることなく静的解析が通るようにしたい...... 

19. 具体的には……

20. 具体的には……
 Illuminate/Support/Collection の get メソッドを使っている部分 が大量に通らなくなってしまった ‼
 

21. 具体的には……
 Illuminate/Support/Collection の get メソッドを使っている部分 が大量に通らなくなってしまった ‼
 
 ERROR: PossiblyNullPropertyFetch - app/Services/Queries/Weapon/WeaponQuery.php:87:19 
 - Cannot get property on possibly null variable $masterWeapon of type mixed|null (see https://psalm.dev/082)
 ? $masterWeapon->id
 $masterWeapon = $mstWeaponsByMaterial Count->get($masterByMaterial->materialCount); 
 psalm/plugin-laravel (v2.8.0) 

22. 具体的には……
 Illuminate/Support/Collection の get メソッドを使っている部分 が大量に通らなくなってしまった ‼
 
 ERROR: PossiblyNullPropertyFetch - app/Services/Queries/Weapon/WeaponQuery.php:87:19 
 - Cannot get property on possibly null variable $masterWeapon of type mixed|null (see https://psalm.dev/082)
 ? $masterWeapon->id
 $masterWeapon = $mstWeaponsByMaterialCount->get($masterByMaterial->materialCount); 
 psalm/plugin-laravel (v2.8.0) 

23. - Cannot get property on possibly null variable $masterWeapon of type mixed|null (see https://psalm.dev/082)
 nullが入る可能性があるよって言われてる

24. - Cannot get property on possibly null variable $masterWeapon of type mixed|null (see https://psalm.dev/082)
 nullが入る可能性があるよって言われてる
 null って mixed に含まれてるんじゃないの？　 >
25. そもそもアプリの仕様上 null が出ることはない......

26. そもそもアプリの仕様上 null が出ることはない......
 null なら 例外 を吐けばよさそう！
 < やったー！

27. first メソッドには、 
 firstOrFail メソッドがある……

28. first メソッドには、 
 firstOrFail メソッドがある……
 一方、get メソッドには、 
 getOrFail メソッドがない……‼
 まじかよ...... >
29. というわけで......

30. というわけで......
 getOrFail メソッド追加すればいいんじゃない？
31. Agenda
 1.　軽い自己紹介　　　　　　　　　　
 
 2.　laravel/framework にPRを出そうとした経緯
 
 3.　実際にPRを出してみた　　　　　　 
 
 4.　それって〇〇と何が違うんだい？
 
 5.　反省点・良かった点・感想

32. まずは laravel/framework への PR の出し方を調べる

33. まずは laravel/framework への PR の出し方を調べる
 ・OSS によって手順やルールが異なるので注意が必要
 
 ・今回は Laravel が指定している方法を確認する必要がある

34. まずは laravel/framework への PR の出し方を調べる
 ・OSS によって手順やルールが異なるので注意が必要
 
 ・今回は Laravel が指定している方法を確認する必要がある
 AI いらすとや　すごい　 >
35. Laravel の場合は公式が Contribution Guide というものを出してる
 ・https://laravel.com/docs/10.x/contributions
 

36. Laravel の場合は公式が Contribution Guide というものを出してる
 ・https://laravel.com/docs/10.x/contributions
 
 ・ブランチの切り方や、コーディングスタイルの指定などがある

37. Laravel の場合は公式が Contribution Guide というものを出してる
 ・https://laravel.com/docs/10.x/contributions
 
 ・ブランチの切り方や、コーディングスタイルの指定などがある
 
 ・resources/css や resources/js など、他のコンパイル済みファイルに影響を与え るものに関しては、メンテナが別途生成しコミットする 　　　　などなど
38. 具体的な作業としては

39. 具体的な作業としては
 ・laravel/frameworkをforkして、手元にcloneしてくるところから 始める
 

40. 具体的な作業としては
 
 ・laravel/frameworkをforkして、手元にcloneしてくるところから 始める
 
 ・手元で変更箇所を実装したら、Conventional Commitsというや り方に則ってコミットを積んであげる
 
 fix: koko kesuto ugokanai >
41. Conventional Commits とは

42. Conventional Commits とは
 ・https://www.conventionalcommits.org/en/v1.0.0/
 
 ・Conventional Commits というのは、コミットメッセージ上の規約のこと 
 
 
 
 

43. Conventional Commits とは
 ・https://www.conventionalcommits.org/en/v1.0.0/
 
 ・Conventional Commits というのは、コミットメッセージ上の規約のこと 
 
 ・feat(lang): add Polish language みたいなやつ
 
 
 

44. Conventional Commits とは
 ・https://www.conventionalcommits.org/en/v1.0.0/
 
 ・Conventional Commits というのは、コミットメッセージ上の規約のこと 
 
 ・feat(lang): add Polish language みたいなやつ
 
 ・セマンティック バージョニング に対応しており、自動化しやすい 
 
 
 

45. Conventional Commits とは
 ・https://www.conventionalcommits.org/en/v1.0.0/
 
 ・Conventional Commits というのは、コミットメッセージ上の規約のこと 
 
 ・feat(lang): add Polish language みたいなやつ
 
 ・セマンティック バージョニング に対応しており、自動化しやすい 
 ・多くのOSSではConventional Commitsのやり方を取り入れている 
 
 

46. 実際にコミットした内容について英語でメッセージを書いていきます
 

47. 実際にコミットした内容について英語でメッセージを書いていきます
 
 ・日本語で書いて deepl を使い翻訳したものを確認したものを使いました
 
 

48. 実際にコミットした内容について英語でメッセージを書いていきます
 
 ・日本語で書いて deepl を使い翻訳したものを確認したものを使いました
 
 

49. 実際にコミットした内容について英語でメッセージを書いていきます
 
 ・日本語で書いて deepl を使い翻訳したものを確認したものを使いました
 
 
 他の人のＰＲなども参考にしたよ > 

50. というわけでいよいよPR提出していくのですが……

51. というわけでいよいよPR提出していくのですが……
 結論から行くと　うまくいきませんでした

52. Agenda
 1.　軽い自己紹介　　　　　　　　　　
 
 2.　laravel/framework にPRを出そうとした経緯
 
 3.　実際にPRを出してみた
 
 4.　それって〇〇と何が違うんだい？　　　
 
 5.　反省点・良かった点・感想

53. 実際にPRをだすと、GitHub上でCIが動き出します
 
 ・各種指定したバージョンでのテストを通過することが必要だった
54. 実際にPRをだすと、GitHub上でCIが動き出します
 
 ・各種指定したバージョンでのテストを通過することが必要だった ・なかなかテストが通らなかったので、手元で修正してコミットを積んでた
55. 実際にPRをだすと、GitHub上でCIが動き出します
 
 ・各種指定したバージョンでのテストを通過することが必要だった ・なかなかテストが通らなかったので、手元で修正してコミットを積んでた ・テストが通ったら squash してコミットをまとめようと思ってた
56. 実際にPRをだすと、GitHub上でCIが動き出します
 
 ・各種指定したバージョンでのテストを通過することが必要だった ・なかなかテストが通らなかったので、手元で修正してコミットを積んでた ・テストが通ったら squash してコミットをまとめようと思ってた
57. すると、まもなくしてレビューコメントをいただきました‼
 

58. すると、まもなくしてレビューコメントをいただきました‼
 
 それって sole メソッドと何が違うんだい？

59. すると、まもなくしてレビューコメントをいただきました‼
 
 それって sole メソッドと何が違うんだい？
 sole ...... ？ >
60. というわけで、sole メソッドについて調べてみた‼

61. というわけで、sole メソッドについて調べてみた‼

62. というわけで、sole メソッドについて調べてみた‼

63. というわけで、sole メソッドについて調べてみた‼
 < たしかに、既にあったわ…… 

64. Agenda
 1.　軽い自己紹介　　　　　　　　　　
 
 2.　laravel/framework にPRを出そうとした経緯
 
 3.　実際にPRを出してみた
 
 4.　それって〇〇と何が違うんだい？
 
 5.　反省点・良かった点・感想　　　　

65. 今回の反省点・分かった点・感想
66. 今回の反省点・分かった点・感想 ・事前に下調べを入念に重ねてから PR を出すべきだった
 
 
 

67. 今回の反省点・分かった点・感想 ・事前に下調べを入念に重ねてから PR を出すべきだった
 
 ・内容はさておき、PRを出すこと自体はそれほど難しくないOSSも存 在する
 
 
 

68. 今回の反省点・分かった点・感想 ・事前に下調べを入念に重ねてから PR を出すべきだった
 
 ・内容はさておき、PRを出すこと自体はそれほど難しくないOSSも存 在する
 
 ・Laravelに限らずphp関連のOSSのコードを理解しようと思うと、どうして もある程度php-srcの理解が必要になる
 

69. 今回の反省点・分かった点・感想 ・事前に下調べを入念に重ねてから PR を出すべきだった
 
 ・内容はさておき、PRを出すこと自体はそれほど難しくないOSSも存 在する
 
 ・Laravelに限らずphp関連のOSSのコードを理解しようと思うと、どうして もある程度php-srcの理解が必要になる
 
 今回はissueや過去のPRも調べたつもりだったけど、そもそも既にある機能だというところが盲点だった
70. ・宣伝
 ・2024年1月開催の phpcon北海道のLT で少しお話しさせていただきます！ 気になります！　>
71. ・宣伝
 ・2024年1月開催の phpcon北海道の 前前夜祭LTでも少しお話しさせていただ きます！ ・内容は未定です 気になります！　>
72. ・宣伝
 ・2024年2月開催の phpcon関西でも少 しお話しさせていただきます！ ・内容はIT初心者にPHP(とDocker, gitなど のツール)を短期間で実用レベルまで叩き こんだという話になります 気になります！　>
73. ご清聴ありがとうございました!!