Upgrade to Pro — share decks privately, control downloads, hide ads and more …

OSSから学んだPR Descriptionの書き方

Fu-ga
January 21, 2023

OSSから学んだPR Descriptionの書き方

2023-01-21(Sat) BuriKaigi 2023 で登壇した際の資料です。

Fu-ga

January 21, 2023
Tweet

More Decks by Fu-ga

Other Decks in Programming

Transcript

  1. HOW to write HOW to write pr description pr description

    at oss at oss B u r i K a i g i 2 0 2 3
  2. ふーが @fugakkbn Ruby / Ruby on Rails 2022.3 エンジニアに転職 前職は警察官👮🏻🚓💨

    趣味はダーツ🎯 Kaigi on Rails Organizer ㍿永和システムマネジメント 所属
  3. 本日の概要 OSS 活動を通じて、PR Description に何を書くのが良いのか、レビ ュアーの負担を減らせる Description はどういったものか、というの を少しずつ感じ取っています。 自分が書いた

    Description をふりかえりながら、これまでに得た気づ きをアウトプットすることで、まだ OSS にコントリビュートしたこと がない方の参考になれば、また、諸先輩方からのフィードバックをい ただける機会になればと思っています。
  4. gem_rbs_collection " D e f i n i t e

    l y T y p e d " a s i n T y p e S c r i p t
  5. Pull Request の概要 ActiveDecorator という gem の一部の API に対する型 定義を追加

    追加した型定義の正当性を担保するテストを追加 皆さんならどういう Description を書きますか?
  6. ruby/gem_rbs_collection #164 P u l l R e q u

    e s t : A d d R B S f o r A c t i v e D e c o r a t o r g e m
  7. ruby/gem_rbs_collection #165 P u l l R e q u

    e s t : A l l o w o p t i o n a l b l o c k f o r # f i n d _ o r _ c r e a t e _ b y
  8. ruby/gem_rbs_collection #168 A l l o w s o m

    e m e t h o d s o f A c t i v e R e c o r d : : R e l a t i o n t o a c c e p t o p t i o n a l b l o c k a r g u m e n t s
  9. getting a little better 少 し ず つ 良 く

    な っ て い る ・ ・ ?
  10. Pull Request の概要 ActiveRecord という gem のとある API の型定義が自 動生成されたもののままで、引数や戻り値の型が

    undefined になっていた undefined のものを(調査した上で)正しい型定義に修 正した
  11. on twitter T w i t t e r で

    見 か け た も の
  12. b y @ k a k u t a n

    i - s a n https://speakerdeck.com/kakutani/agile-manifesto-decade?slide=76
  13. K A I Z E N ふ り か え

    っ て の 改 善 案
  14. ruby/gem_rbs_collection #226 F i x A c t i v

    e R e c o r d : : B a s e . a f t e r _ c r e a t e t o b e c a l l a b l e w i t h b l o c k
  15. Make the "Kata" Make the "Kata" - 自 分 の

    ” カ タ ” を 作 る -
  16. scale out to work scale out to work - 業

    務 へ の 横 展 開 -