Share
Embed
Transcript
19 slides
-
WED Crafters Night ऀ থل (Musha Akinori) • Senior Expert
(Web) at WED, Inc. ◦ Software Architect (API, DB, App, System Infrastructure) • GitHub, Twitter: @knu • Ruby Committer (2000-), Huginn co-maintainer, FreeBSD ex- committer • Ruby, JavaScript/TS, Go; Lua, Elisp, Zsh, C 2 ࣗݾհ Who's speaking -
WED Crafters Night Contents 01 அʹඞཁͳࡐྉΛఏڙ͠Α͏ Help reviewers make an
informed decision 02 খ͍͞είʔϓͰಥഁ͠Α͏ Keep issue scope small 03 ޓੑΛܰࢹ͠ͳ͍ɺॏࢹ͗͢͠ͳ͍ Do not underestimate nor overestimate compatibility 04 ϨϏϡϫʔͷؾΛࢄΒ͞ͳ͍ Never distract reviewers 05 ·ͱΊ Wrap-up 3 -
WED Crafters Night ϨϏϡϫʔɺ͍͍ͷͰ͋ΕऔΓೖΕ͍ͨɻͯ͞ɺͦΕ͍͍ͷͳͷ͔ʁ • ʮաڈʹࣅͨཁͳ͔͚ͬͨͬʁʯ Α͘ௐͯɺ͠ࣅͨཁ͕աڈʹڋઈ͞Ε͍ͯͨΒͦΕͱͷҧ͍Λૌ͑Α͏ɻ • ʮΈΜͳ͕ඞཁͱ͍ͯ͠Δ͔ʁʯ ຊ͜͏ॻ͚ͨΒ͏Ε͍ͣ͠ɺͱ͍͏࣮ྫΛूΊͯϢʔεέʔεΛࣔͦ͏ɻ
• ʮػೳʢؔʣͷ໊લ࣮ํࣜద͔ʁʯ ੈʹ͋ΔଞͷݴޠɺϥΠϒϥϦɺAPIΛௐͯใΛఏڙ͠Α͏ɻ 5 அʹඞཁͳࡐྉΛఏڙ͠Α͏ Help reviewers make an informed decision -
WED Crafters Night ռΊ💡 • ໊લॏཁɻͰɺͰ͖Ε໊͔͍͍ͬ͜લΛʮൃ໌ʯ͠ͳ͍͜ͱɻ ଞͷࣄྫʹ฿͓͏ɻΈΜͳͷ಄ʹ͢Ͱʹ͋ΔطଘͷޠኮΛ׆༻͠Α͏ɻ •
Ϣʔεέʔεͱʹ͔͘େࣄɻͻͨ͢Βʹݱ࣮త͔ͭΤϨΨϯτͳྫΛࣔ͠ɺͦΕ ͕ͳ͍߹ͷΞυϗοΫͳίʔυͱରൺͤ͞Α͏ɻ • ֎ͷੈք͕Ͳ͏ͳ͍ͬͯΔ͔ϨϏϡϫʔҙ͍ࣝͯ͠ΔɻҰํͰϥΠόϧ͕͜͏ ͔ͩΒɺ͚ͩͩͱఢጊ৺ΛἤΔ͜ͱʹͳΔͷͰɺ͘ྫΛऩू͠Α͏ɻ 6 அʹඞཁͳࡐྉΛఏڙ͠Α͏ Help reviewers make an informed decision -
WED Crafters Night େͳߏͷͯ͢ΛͲ͔Μͱཁ͢ΔͱɺϨϏϡʔର͕૿͑ɺେͳ ӴઢΛظઓͰઓ͏ӋʹͳΔɻ • PRΛड͚ͨଆɺܾஅࣄ߲͕ଟ͍ͱ߹ͤʹ໎͏͠ɺड͚ೖΕͮΒ͍ɻ ࠷ऴతͳֆࣗͷ৺ʹൿΊͯɺΦϓγϣϯ࠷খݶ·Ͱ͗མͱ͠ɺίΞ ͷύʔπΛҰͭͣͭݸผܸഁ͍ͯ͜͠͏ɻ
• γϯάϧΠγϡʔͷํ͕௨͍͢͠ɻ 8 খ͍͞είʔϓͰಥഁ͠Α͏ Keep issue scope small -
WED Crafters Night ռΊ💡 • ਓͷϦΫΤετʹ͔ͬͬͯզాҾਫ͠ͳ͍ɻ·ͯ͠ɺΑΓқͷߴ͍ʹ͢Γସ͑ͳ͍ɻγ ϯϓϧͳղܾʹूத͠Α͏ɻ • ͍͠ίʔφʔέʔε୨্͍͍͛ͯ͠ɻΤϥʔΛग़͢Α͏ʹ͓͍ͯͯ͠ɺޙͰରԠ͢Δͷखɻ
• ରশੑ͕͋Δͱ͔ཧతʹඒ͍͠ͱ͔͋͘·ͰϢʔεέʔεͷิڧʹ͏ͷɻҝʹ͢Δ͚ͩͷ ཁආ͚Α͏ɻ"YAGNI" • RubyຊମʹRails (ActiveSupport)ͷػೳΛΠϯϙʔτ͢ΔࡍͳͲ৻ॏʹۛຯͯ͠ɺRubyͷྲّྀ ʹ߹Θͳ͍෦ࣺͯͭͭগͣͭ͠औΓࠐΜͰ͍Δɻ ྫɿHash#slice, except 10 খ͍͞είʔϓͰಥഁ͠Α͏ Keep issue scope small -
WED Crafters Night ޓੑͷഁյΈΜͳ͕ݏ͏ɻ • ϢʔβʔͪΖΜɺϢʔβʔͨͪͷલʹཱͭϝϯςφʔɻ • ͍͘Βϓϥε͕େ͖ͯ͘ɺطଘͷΞϓϦΛյ͢ϚΠφε༊͞Εͳ͍ɻ • չ͍͕͠ɺաڈͷઃܭͷࣦഊͤͳ͍͜ͱଟ͍ɻ
ຊ࣭తʹɺόάमਖ਼ΛؚΊͯͯ͢ͷมߋޓੑʹӨڹ͢Δɻ • ์ஔ͞Εଓ͚ͨόάϢʔβʔʹͱ༷ͬͯͰ͋ΓɺͦΕʹґଘ͢Δίʔ υͩͬͯ͋Δɻ 12 ޓੑΛܰࢹ͠ͳ͍ɺॏࢹ͗͢͠ͳ͍ Do not underestimate nor overestimate compatibility -
WED Crafters Night ҰํͰɺΤϥʔʹͳΔ༻๏νϟϯεɻͦ͜৽ػೳΛೖΕࠐΉ伱ؒʹͳΔɻ • ఆ֎ͷҾɺڐ͞Εͳ͔ͬͨจ๏ ੬ऑੑޡಈ࡞ɺੑೳΛট͘Α͏ͳ͍ํΉ͠ΖഇࢭʢඇਪԽʣ͖͢͜ ͱ͋Δɻ • ·͍͠༻๏ΛՃ͢Δ৽͍͠APIΛ࡞ͬͯҠߦΛଅͦ͏ɻ
13 ޓੑΛܰࢹ͠ͳ͍ɺॏࢹ͗͢͠ͳ͍ Do not underestimate nor overestimate compatibility -
WED Crafters Night ռΊ💡 • ৽͍͠όʔδϣϯʢAPIʣʹՃ͞ΕͨػೳΛݹ͍ํʹόοΫϙʔτ͢ Δͷɺ৽͍͠ͷΛ͏ΠϯηϯςΟϒΛݮΒͯ͠ҠߦΛΒͤΔ͜ ͱʹͳΔɻ Ruby 1.8→1.9ͷҠߦظʹ͍͠அ͕ඞཁͩͬͨ🥺
• ϢʔεέʔεਪଌͰͳ࣮͘ࡍʹௐΑ͏ɻRubyͷ։ൃʹ͓͍ͯɺ͢ ͯͷެ։gemͷιʔεΛίʔυαʔνͯ͠ௐ͍ࠪͯ͠Δɻ 14 ޓੑΛܰࢹ͠ͳ͍ɺॏࢹ͗͢͠ͳ͍ Do not underestimate nor overestimate compatibility -
WED Crafters Night • ίʔυ͕͍ͬͯΔ͜ͱେࣄɻ͜ͷ͍ͬͯΔͱɺελΠϧΨΠυपลߦͷ ελΠϧʹԊ͍ͬͯΔ͜ͱɻͦ͜Ͱࣗͷඒҙࣝԡ͠ग़͞ͳ͍ɻ • CIͷΤϥʔlintܯࠂ͕ग़ͨΒɺશ෦௵͔ͯ͠ΒվΊͯϨϏϡʔґཔ͠Α͏ɻ
• ϨϏϡʔதͷrebasesquashϓϩδΣΫτͷश׳ϨϏϡϫʔͷࢦࣔʹै͓ ͏ɻແஅͰsquash͢ΔͱؾΛ͢Δਓ͍Δ͠ɺ͖Ε͍ʹཧɾׂ͞Εͨί ϛοτΛॱʹಡΉͷΛΉਓ͍Δɻ • ࣮ํ๏ํʹ͍ͭͯΘ͔Βͳ͍͜ͱɺܾΊͯ΄͍͜͠ͱੵۃతʹϨϏϡϫʔ ʹฉ͜͏ɻ࣭ʹରౖͯ͠Δਓ͍ͳ͍ɻ 16 ϨϏϡϫʔͷؾΛࢄΒ͞ͳ͍ Never distract reviewers -
WED Crafters Night ռΊ💡 • git add -p ΤσΟλͷ෦εςʔδػೳΛ͏·ͬͯ͘ɺελΠϧमਖ਼ ϦϑΝΫλϦϯάɺCIϏϧυ༻ͷมߋͱػೳతมߋͷίϛοτΛ͚
Α͏ɻػೳ࣮ݱʹඞਢͰͳ͍มߋɺϝϯςφʔͷઐݖࣄ߲ͳͷͰඞཁ࠷ খݶʹ͢Δɻ • ࣗͷཁʹ͔ͬͬͯείʔϓΛ͛Δਓ͕ग़͖ͯͨΒܯռ͠Α͏ɻཧ ղऀ͕ݱΕͨͱتΜͰ҆қʹܴ߹ͯ͠͠·Θͳ͍͜ͱɻͦΕผʹissue Λ্͛ͯɺͱಥ͖์͢ͷେࣄɻ 17 ϨϏϡϫʔͷؾΛࢄΒ͞ͳ͍ Never distract reviewers -
WED Crafters Night • Ͳ͏ͨ͠ΒϨϏϡϫʔ͕͍͍Ͷͱݴ͍͍͔͢ɺؾ࣋ͪΑ͘approveͰ͖Δ ͔ɺਅ伨ʹਓͷؾ࣋ͪʹͳͬͯߟ͑ΔɻਓؒΛ૬खͱ͢Δ͠͞Λָ͠ ͏ɻ • ͱʹ͔͘ਅ໘ͳϦαʔν͕େࣄɻ͕ࣗΠγϡʔΛൃݟͨ͠ஈ֊ͰΑ͘ ௐΔɻ͍Ͱ࣮ͯ͠͠·ͬͯɺػೳཁΛग़͢ͱ͖ʹվΊͯݚڀ͢
Δɻ • େ͖ͳখ͘͞ղ͢Δɻ୯ʹ෦ʹ͚Δ͚ͩͰͳ͘ɺߏػߏ Λൈ͖ग़͢ɻૣ͘औΓࠐ·Ε͚ͨΕඞਢͰͳ͍ͷΛେʹ͗མͱ͢ɻ • ܁Γฦͯ͠͠ɺࣗͷఏҊ͕࣮݁͢ΔୡײΛຯΘ͍ͬͯͩ͘͞ʂ 19 ·ͱΊ Wrap-up