Skip to content

Latest commit

ย 

History

History
57 lines (43 loc) ยท 2.67 KB

File metadata and controls

57 lines (43 loc) ยท 2.67 KB

Pull Request & Code Review Guidelines

์ด ๋ฌธ์„œ๋Š” ์ด ํ”„๋กœ์ ํŠธ์˜ Pull Request(PR) ์ž‘์„ฑ ๋ฐ ์ฝ”๋“œ ๋ฆฌ๋ทฐ ์‹œ ์ง€์ผœ์•ผ ํ•  ๊ทœ์น™๊ณผ ํฌ๋งท์„ ์ •์˜ํ•ฉ๋‹ˆ๋‹ค.
๊ธฐ์—ฌ์ž์™€ ๋ฆฌ๋ทฐ์–ด ๋ชจ๋‘๊ฐ€ ํšจ์œจ์ ์ด๊ณ  ์ผ๊ด€๋œ ํ˜‘์—…์„ ํ•  ์ˆ˜ ์žˆ๋„๋ก ๋„์›€์„ ์ค๋‹ˆ๋‹ค.

โœ… PR ์ž‘์„ฑ ํฌ๋งท

PR์„ ์ƒ์„ฑํ•  ๋•Œ๋Š” ์•„๋ž˜ ํ˜•์‹์„ ๋”ฐ๋ผ ์ฃผ์„ธ์š”:

## #๏ธโƒฃ Issue Number
<!-- ex) #์ด์Šˆ๋ฒˆํ˜ธ, #์ด์Šˆ๋ฒˆํ˜ธ -->
- ์˜ˆ์‹œ: #32

## ๐Ÿ“ ์š”์•ฝ(Summary)
<!-- ํ•ด๋‹น PR์— ๋Œ€ํ•ด์„œ ๊ฐ„๋‹จํžˆ ์„ค๋ช…ํ•ด์ฃผ์„ธ์š”(3์ค„ ์ด๋‚ด). (Why? How?) -->
<!-- (์„ธ๋ถ€์ ์ธ ๋‚ด์šฉ์€ Issue์— ์ž‘์„ฑ๋˜์—ˆ์„ ๊ฒƒ์ด๋ผ๊ณ  ๊ฐ€์ •ํ•ฉ๋‹ˆ๋‹ค) -->
- ์˜ˆ์‹œ: ๋ธŒ๋žœ์น˜ ์ „๋žต ๊ฐ€์ด๋“œ๋ผ์ธ ๋ฌธ์„œ ์ถ”๊ฐ€  
- ํ”„๋กœ์ ํŠธ ๋‚ด ์ปจํŠธ๋ฆฌ๋ทฐ์…˜ ํ๋ฆ„ ์ •๋ฆฌ๋ฅผ ์œ„ํ•œ ์ž‘์—…  
- ์‹ ๊ทœ ๊ธฐ์—ฌ์ž onboarding ์‹œ ์ฐธ๊ณ  ๋ฌธ์„œ๋กœ ํ™œ์šฉ ์˜ˆ์ •

## ๐Ÿ’ฌ  To Reviewers (์„ ํƒ)
<!-- ๋ฆฌ๋ทฐ์–ด๊ฐ€ ์ค‘์ ์ ์œผ๋กœ ๋ด์คฌ์œผ๋ฉด ์ข‹๊ฒ ๋Š” ๋ถ€๋ถ„์ด ์žˆ์œผ๋ฉด ์ž‘์„ฑํ•ด์ฃผ์„ธ์š”. -->
- ์˜ˆ์‹œ: ๋ฌธ์„œ ๊ตฌ์กฐ๋‚˜ ์šฉ์–ด ์„ ํƒ์ด ์ž์—ฐ์Šค๋Ÿฌ์šด์ง€ ํ™•์ธ ๋ถ€ํƒ๋“œ๋ฆฝ๋‹ˆ๋‹ค.

## PR Checklist
<!-- [x] ํ•ญ๋ชฉ ์™„๋ฃŒ ์—ฌ๋ถ€ ์ฒดํฌํ•ด์ฃผ์„ธ์š” -->
- [x] ๋ณ€๊ฒฝ ์‚ฌํ•ญ์— ๋Œ€ํ•œ ํ…Œ์ŠคํŠธ ๋˜๋Š” ๊ฒ€์ฆ ์™„๋ฃŒ
- [x] ๋กœ์ปฌ์—์„œ ์ •์ƒ ๋™์ž‘ ํ™•์ธ
- [ ] ๊ด€๋ จ ๋ฌธ์„œ ์—…๋ฐ์ดํŠธ ์™„๋ฃŒ

๐Ÿ” Code Review Emoji Rules

๋ฆฌ๋ทฐ์–ด๋Š” ์•„๋ž˜์˜ ์ด๋ชจ์ง€ ๊ทœ์น™์— ๋”ฐ๋ผ ํ”ผ๋“œ๋ฐฑ์„ ๋‚จ๊ฒจ์ฃผ์„ธ์š”.
์„œ๋กœ์˜ ์˜๋„๋ฅผ ๋ช…ํ™•ํžˆ ์ „๋‹ฌํ•˜๋Š” ๋ฐ ๋„์›€์ด ๋ฉ๋‹ˆ๋‹ค.

์ด๋ชจ์ง€ ์˜๋ฏธ ์‚ฌ์šฉ ์˜ˆ์‹œ
๐Ÿ‘ ์นญ์ฐฌ (Good Job) ๊ตฌ์กฐ๊ฐ€ ๊น”๋”ํ•˜๊ณ  ์ฝ๊ธฐ ์‰ฌ์šด ์ฝ”๋“œ์ž…๋‹ˆ๋‹ค!
โ— ํ•„์ˆ˜ ์ˆ˜์ • (Required) ์ด ๋ถ€๋ถ„์€ ์˜ˆ์™ธ ์ฒ˜๋ฆฌ๊ฐ€ ํ•„์š”ํ•ด ๋ณด์—ฌ์š”. ๊ผญ ์ˆ˜์ •ํ•ด์ฃผ์„ธ์š”.
โ“ ์งˆ๋ฌธ (Clarify) ์ด ๋กœ์ง์ด ์ด๋Ÿฐ ๋ฐฉ์‹์œผ๋กœ ๊ตฌ์„ฑ๋œ ์ด์œ ๊ฐ€ ์žˆ์„๊นŒ์š”?
๐Ÿ’Š ์ œ์•ˆ (Optional Suggestion) ์ด ๋ถ€๋ถ„์€ map ๋Œ€์‹  flatMap๋„ ๊ณ ๋ คํ•ด๋ณผ ์ˆ˜ ์žˆ์„ ๊ฒƒ ๊ฐ™์•„์š”.

๐Ÿ” ๋ฆฌ๋ทฐ ํ”„๋กœ์„ธ์Šค

  1. PR ์ƒ์„ฑ์ž๋Š” 2๋ช… ์ด์ƒ์˜ ๋ฆฌ๋ทฐ์–ด๋ฅผ ์ง€์ •ํ•ฉ๋‹ˆ๋‹ค.
  2. ๋ฆฌ๋ทฐ์–ด๋Š” ์œ„์˜ ์ด๋ชจ์ง€ ๊ทœ์น™์— ๋”ฐ๋ผ ํ”ผ๋“œ๋ฐฑ์„ ๋‚จ๊น๋‹ˆ๋‹ค.
  3. ๋ฆฌ๋ทฐ์–ด ์ „์›์ด โ— ํ•ญ๋ชฉ์„ ํ•ด์†Œํ•œ ํ›„ ๐Ÿ‘ ๋˜๋Š” ์Šน์ธ(approve)์„ ๋‚จ๊ธฐ๋ฉด ๋ณ‘ํ•ฉ ๊ฐ€๋Šฅํ•ฉ๋‹ˆ๋‹ค.
  4. ๋ณ‘ํ•ฉ ์ „์—๋Š” ๊ฐ€๊ธ‰์  master ๋ธŒ๋žœ์น˜๋ฅผ ๊ธฐ์ค€์œผ๋กœ ์ตœ์‹  ์ƒํƒœ๋กœ ์œ ์ง€ํ•ด์ฃผ์„ธ์š”.

๐Ÿ“Œ ๊ธฐํƒ€ ๊ถŒ์žฅ ์‚ฌํ•ญ

  • ์ปค๋ฐ‹ ๋ฉ”์‹œ์ง€๋Š” ๋ช…ํ™•ํ•˜๊ณ  ๋ชฉ์  ์ค‘์‹ฌ์ ์œผ๋กœ ์ž‘์„ฑํ•ด์ฃผ์„ธ์š”.
    • ์˜ˆ: docs: add branch guidelines documentation
  • ํ•˜๋‚˜์˜ PR์—๋Š” ๊ฐ€๋Šฅํ•œ ํ•œ ์˜๋ฏธ ์žˆ๋Š” ๋‹จ์œ„์˜ ์ž‘์—…๋งŒ ํฌํ•จํ•ด์ฃผ์„ธ์š”.
  • ๊ธฐ๋Šฅ ๋‹จ์œ„ ์ปค๋ฐ‹ โ†’ PR ๋‹จ์œ„ ๋ฆฌ๋ทฐ โ†’ ๋ณ‘ํ•ฉ์ด๋ผ๋Š” ํ๋ฆ„์„ ์ง€์ผœ์ฃผ์„ธ์š”.