Skip to content

Latest commit

ย 

History

History

Git

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
ย 
ย 

Git

Branch

Jira ์ด์Šˆ๋กœ๋ถ€ํ„ฐ ํŒŒ์ƒ๋œ ์ž‘์—…์— ์ ์šฉ๋˜๋Š” ๊ทœ๋ฒ”์ž…๋‹ˆ๋‹ค.
๊ถŒ์žฅ์‚ฌํ•ญ์œผ๋กœ ๊ฐ•์ œํ•˜์ง€๋Š” ์•Š์œผ๋ฉฐ, ํ™œ์šฉ ์—ฌ๋ถ€๋Š” ํŒ€์˜ ์ž์œจ์— ๋งก๊น๋‹ˆ๋‹ค.

[์ฐธ๊ณ ] Jira ์šฉ์–ด ์„ค๋ช…

  • Jira ์ด์Šˆ: ํ”„๋กœ์ ํŠธ์— ํฌํ•จ๋œ ์นด๋“œ ํ•˜๋‚˜ํ•˜๋‚˜
  • Jira ์ด์Šˆ ํ‚ค: {ํ”„๋กœ์ ํŠธ ์•ฝ์–ด}-{์‹๋ณ„๋ฒˆํ˜ธ} ํ˜•์‹์˜ Jira ์ด์Šˆ์— ํ• ๋‹น๋œ ๊ณ ์œ ํ•œ ๋ฌธ์ž์—ด (e.g. BE-12)
  • Jira ์ด์Šˆ ๋งํฌ: Jira ์ด์Šˆ์— ๋Œ€ํ•œ ์›น ํŽ˜์ด์ง€๋กœ ์—ฐ๊ฒฐ๋˜๋Š” URL

{Jira ์ด์Šˆ ํ‚ค}--{๋ธŒ๋žœ์น˜ ์ž‘์—… ๋‚ด์šฉ}์œผ๋กœ ์ƒ์„ฑํ•ฉ๋‹ˆ๋‹ค.
Jira ์ด์Šˆ ํ‚ค ๋’ค์— ๋ธŒ๋žœ์น˜ ์ž‘์—… ๋‚ด์šฉ์„ ์ƒ๋žตํ•  ์ˆ˜ ์žˆ์œผ๋‚˜, ๊ฐ€๊ธ‰์  ํฌํ•จํ•˜๊ธฐ๋ฅผ ๊ถŒ์žฅํ•ฉ๋‹ˆ๋‹ค. ๋ธŒ๋žœ์น˜ ์ž‘์—… ๋‚ด์šฉ์€ ํ•œ๊ตญ์–ด ํ˜น์€ ์˜์–ด๋กœ ์ ์œผ๋ฉฐ ๋„์–ด์“ฐ๊ธฐ๋Š” -๋กœ ํ‘œ๊ธฐํ•ฉ๋‹ˆ๋‹ค.

  • ์„œ๋‘์— Jira ์ด์Šˆ ํ‚ค๋ฅผ ๋„ฃ์Šต๋‹ˆ๋‹ค.
  • Jira ์ด์Šˆ์˜ ๋ธŒ๋žœ์น˜ ๋งŒ๋“ค๊ธฐ ๊ธฐ๋Šฅ์ด ๊ธฐ๋ณธ์œผ๋กœ ์ œ๊ณตํ•˜๋Š” --๋ฅผ ๊ตฌ๋ถ„์ž๋กœ ์‚ผ์Šต๋‹ˆ๋‹ค.

Do

BE-12--์ƒํ’ˆ-๋ชฉ๋ก-API-์˜ค๋ฅ˜-ํ•ด๊ฒฐ (๊ถŒ์žฅ)
BE-12--fix-deal-list-api (๊ถŒ์žฅ)
BE-12

Don't

BE-12--fix_deal_list_api
fix-deal-list-api
์ƒํ’ˆ-๋ชฉ๋ก-API-์˜ค๋ฅ˜-ํ•ด๊ฒฐ

Commit Message

์ปค๋ฐ‹ ๋ฉ”์‹œ์ง€๋Š” ๋‹ค์Œ๊ณผ๊ฐ™์€ ํ˜•ํƒœ๋กœ ์ž‘์„ฑํ•ฉ๋‹ˆ๋‹ค. ์ฒซ ์ค„์˜ ์ปค๋ฐ‹ ๋ฉ”์‹œ์ง€๋กœ ๋ณ€๊ฒฝ์‚ฌํ•ญ์„ ์–ด๋Š์ •๋„ ์ธ์ง€ํ•  ์ˆ˜ ์žˆ๋„๋ก ์ž‘์„ฑํ•ฉ๋‹ˆ๋‹ค.

{PREFIX}: ๋ณ€๊ฒฝ ์‚ฌํ•ญ ์š”์•ฝ

์ƒ์„ธ ์„ค๋ช…

#Issue, Bug, Sentry link

์—ฌ๊ธฐ์„œ PREFIX๋Š” ๋‹ค์Œ ์ค‘ ์ ์ ˆํ•œ ๊ฒƒ์„ ์‚ฌ์šฉํ•ฉ๋‹ˆ๋‹ค.

  • ADD: ๊ธฐ๋Šฅ ์ถ”๊ฐ€
  • CHG: ๊ธฐ๋Šฅ ๋ณ€๊ฒฝ
  • FIX: ์˜ค๋ฅ˜ ์ˆ˜์ •
  • REF: ๋ฆฌํŒฉํ† ๋ง
  • DEL: ์ œ๊ฑฐ

Do

ADD: ํˆฌ์ž ์‹œ๋ฆฌ์–ผ๋ผ์ด์ € ์ถ”๊ฐ€
DEL: ํˆฌ์ž ๋ทฐ ์ œ๊ฑฐ
FIX: PEP8 ์ˆ˜์ •

FIX: ํƒ€์ž… ์ˆ˜์ •  

ํƒ€์ž… ์˜ค๋ฅ˜๋กœ ์ธํ•ด ๋ฐœ์ƒํ•œ ์žฅ์•  ๋Œ€์‘

# https://Sentry.io/issue=123

Don't

ํˆฌ์ž ๋ทฐ ์ถ”๊ฐ€
CHG: ๋กœ์ง ๋ณ€๊ฒฝ

Pull Request

์ œ๋ชฉ

PR์„ ์ž‘์„ฑ์‹œ์— ๋‹ค์Œ์˜ ์–‘์‹์— ๋งž์ถ”์–ด ์ œ๋ชฉ์„ ์ž‘์„ฑํ•ฉ๋‹ˆ๋‹ค.

  • [{Jira ์ด์Šˆ ํ‚ค}] {๋‚ด์šฉ}

Do

[BE-12] ์ƒํ’ˆ ๋ชฉ๋ก API ์˜ค๋ฅ˜ ํ•ด๊ฒฐ

Don't

์ƒํ’ˆ ๋ชฉ๋ก API ์˜ค๋ฅ˜ ํ•ด๊ฒฐ

Description

  • ๋ฆฌ๋ทฐ ์š”์ฒญ์ž๋Š” ๋ฆฌ๋ทฐ์–ด๊ฐ€ ๋ฆฌ๋ทฐ ์š”์ฒญ์ž๊ฐ€ ์•Œ๊ณ  ์žˆ๋Š” ๋‚ด์šฉ์„ ๋‹น์—ฐํ•˜๊ฒŒ ์•Œ๊ณ ์žˆ๋‹ค๋ผ๋Š” ๊ฐ€์ •์„ ํ•˜์ง€ ์•Š์Šต๋‹ˆ๋‹ค.
  • ๋ฆฌ๋ทฐ ์š”์ฒญ์ž๋Š” ๋ฆฌ๋ทฐ์–ด์—๊ฒŒ ๋ณ€๊ฒฝ์‚ฌํ•ญ๊ณผ ๊ด€๋ จ๋œ ์ถฉ๋ถ„ํ•œ ๋ฌธ๋งฅ์„ ์ „๋‹ฌํ•ฉ๋‹ˆ๋‹ค.

๋งŒ์•ฝ ์ž‘์„ฑ์— ์–ด๋ ค์›€์„ ๊ฒช๊ณ ์žˆ๋‹ค๋ฉด ๋‹ค์Œ ํ•ญ๋ชฉ์— ๋Œ€ํ•ด ๋‹ต๋ณ€์„ ํ•˜๋Š” ๋ฐฉ์‹์œผ๋กœ ์ž‘์„ฑํ•ฉ๋‹ˆ๋‹ค.

  1. ์ด ์ผ์ด ์™œ ์‹œ์ž‘๋˜์—ˆ๋Š”์ง€์— ๋Œ€ํ•œ ์„ค๋ช…
  2. PR์˜ ๋‚ด์šฉ์„ ์ดํ•ดํ•˜๊ธฐ ์œ„ํ•œ ๋ฐฐ๊ฒฝ์— ๋Œ€ํ•œ ์„ค๋ช…
  3. ํ˜„์žฌ์˜ ์ƒํƒœ์™€ ๋ฏธ๋ž˜์— ๋ณ€๊ฒฝ๋˜์–ด์•ผ ํ•  ๋‚ด์šฉ์— ๋Œ€ํ•œ ๊ฐ„๋‹จํ•œ ์„ค๋ช…

Do

- ์ด ์ผ์€ XXX ๋ผ๋Š” ํ”„๋กœ์ ํŠธ์—์„œ ์‹œ์ž‘๋˜์—ˆ์Šต๋‹ˆ๋‹ค.
- ์ด ๋ณ€๊ฒฝ์‚ฌํ•ญ์„ ์ดํ•ดํ•˜๊ธฐ ์œ„ํ•ด์„œ๋Š” ์•„๋ž˜ ์ฐธ๊ณ ๋ฌธ์„œ๋กœ ์ฐธ์กฐํ•œ ๋ฌธ์„œ๋ฅผ ์ฝ์–ด๋ณด์‹œ๋ฉด ๋„์›€์ด ๋ฉ๋‹ˆ๋‹ค.
- ํ˜„์žฌ๋Š” A ๋ผ๋Š” ๋™์ž‘์„ ํ•˜๊ณ ์žˆ๋Š” ์ƒํƒœ์ธ๋ฐ ์ด๊ฒƒ์„ B ๋กœ ๋ฐ”๊พธ์–ด C ๋ผ๋Š” ํšจ๊ณผ๋ฅผ ๊ธฐ๋Œ€ํ•ฉ๋‹ˆ๋‹ค.

Don't

- XXX ํ”„๋กœ์ ํŠธ์—์„œ C ๋ผ๋Š” ํšจ๊ณผ๋ฅผ ๋‚ด๊ธฐ ์œ„ํ•ด์„œ ๋ณ€๊ฒฝํ•ฉ๋‹ˆ๋‹ค.
- A ์—์„œ B ๋กœ ๋ณ€๊ฒฝ

Changes

  • ๋ณ€๊ฒฝ๋˜๋Š” ๋‚ด์šฉ์„ ๊ฐœ๋ณ„ ํ•ญ๋ชฉ์œผ๋กœ ์ชผ๊ฐœ์–ด ์ž‘์„ฑํ•ฉ๋‹ˆ๋‹ค.
  • ์ฝ”๋“œ์˜ ๋ณ€๊ฒฝ์‚ฌํ•ญ์„ ์ตœ๋Œ€ํ•œ ์ „๋‹ฌํ•˜์—ฌ ๋ฆฌ๋ทฐ์–ด๊ฐ€ ์ฝ”๋“œ์˜ ๋ณ€๊ฒฝ ์ง€์ ์„ ์–ด๋Š์ •๋„ ์˜ˆ์ธกํ•˜๋„๋ก ํ•ฉ๋‹ˆ๋‹ค.

Do

- A ๋ชจ๋ธ์˜ ์ธ์Šคํ„ด์Šค ๋ฉ”์„œ๋“œ์˜ ์ฃผ์„์„ ์ˆ˜์ •ํ•ฉ๋‹ˆ๋‹ค.
- B ํ•จ์ˆ˜์˜ ๋ฐ˜ํ™˜๊ฐ’์„ ๋ณ€๊ฒฝํ•ฉ๋‹ˆ๋‹ค.
- C ํ•จ์ˆ˜์˜ ๋งค๊ฐœ๋ณ€์ˆ˜๋ช…์„ ์ ์ ˆํ•œ ์ด๋ฆ„์œผ๋กœ ๋ณ€๊ฒฝํ•ฉ๋‹ˆ๋‹ค.

Don't

- A ํŒŒ์ผ ์ฝ”๋“œ ๋ณ€๊ฒฝ

Reference

  • ๋ณ€๊ฒฝ์‚ฌํ•ญ๊ณผ ๊ด€๋ จ์ด ์žˆ๋Š” ํ˜‘์—… ๋„๊ตฌ๋“ค์˜ ๋งํฌ๋“ค์„ ์ œ๊ณตํ•ด์ฃผ์„ธ์š”.
  • ์‹œ๊ฐ์ ์ธ ๋ณ€๊ฒฝ์ธ ๊ฒฝ์šฐ, ์Šคํฌ๋ฆฐ์ƒท, GIF ๋“ฑ์„ ์ ๊ทน ํ™œ์šฉํ•ด์ฃผ์„ธ์š”.

PR review

Comment Label

  • ๋ฆฌ๋ทฐ์–ด๋Š” ์ฝ”๋ฉ˜ํŠธ๋ฅผ ๋‚จ๊ธธ ๋•Œ, ์ฝ”๋ฉ˜ํŠธ์˜ ์˜๋„์— ๋”ฐ๋ผ ์ ์ ˆํ•œ ๋ผ๋ฒจ์„ ์‚ฌ์šฉํ•˜์—ฌ ๋ฆฌ๋ทฐ ์š”์ฒญ์ž๊ฐ€ ์ฝ”๋ฉ˜ํŠธ์˜ ์˜๋„๋ฅผ ๋” ์ž˜ ์ดํ•ดํ•  ์ˆ˜ ์žˆ๊ฒŒ ํ•ฉ๋‹ˆ๋‹ค.
  • ๋ผ๋ฒจ๊ณผ ์ฝ”๋ฉ˜ํŠธ ์‚ฌ์ด์˜ ๊ตฌ๋ถ„์ž์˜ ํŠน๋ณ„ํ•œ ์ œํ•œ์€ ์—†์Šต๋‹ˆ๋‹ค. ํŽธํ•œ๊ฒƒ์„ ์‚ฌ์šฉํ•ด์ฃผ์„ธ์š”.
1(Request Changes)  2(Request Changes)  3(Comment)     4(Approve)      5(Approve)
:-------------------:-------------------:-------------------:-------------------:
๋ณ€๊ฒฝ ์š”๊ตฌ๋„ ๋†’์Œ                                                         ๋ณ€๊ฒฝ ์š”๊ตฌ๋„ ๋‚ฎ์Œ


1: ๊ผญ ๋ฐ˜์˜ํ•ด์ฃผ์„ธ์š” (Request changes)
- ๋ฆฌ๋ทฐ์–ด๋Š” ๋ณ€๊ฒฝ์‚ฌํ•ญ์ด ์„œ๋น„์Šค์— ์ค‘๋Œ€ํ•œ ์˜ค๋ฅ˜๋ฅผ ๋ฐœ์ƒํ•  ์ˆ˜ ์žˆ๋Š” ๊ฐ€๋Šฅ์„ฑ์„ ์ž ์žฌํ•˜๊ณ  ์žˆ๋Š” ๊ฒฝ์šฐ ์ด ๋ผ๋ฒจ์„ ์‚ฌ์šฉํ•ฉ๋‹ˆ๋‹ค.
- ๋ฆฌ๋ทฐ ์š”์ฒญ์ž๋Š” ์ด ์˜๊ฒฌ์„ ์š”์ฒญ์„ ๋ฐ˜์˜ํ•ฉ๋‹ˆ๋‹ค.
- ๋งŒ์•ฝ ๋ฐ˜์˜ํ•˜๊ธฐ ์–ด๋ ค์šด ๊ฒฝ์šฐ, ํ•ฉ๋ฆฌ์ ์ธ ์˜๊ฒฌ์„ ํ†ตํ•ด ๋ฆฌ๋ทฐ์–ด๋ฅผ ์„ค๋“ํ•ด์•ผ๋งŒ ํ•ฉ๋‹ˆ๋‹ค.

2: ์ ๊ทน์ ์œผ๋กœ ๊ณ ๋ คํ•ด์ฃผ์„ธ์š” (Request changes)
- ๋ฆฌ๋ทฐ์–ด๋Š” ๋ณ€๊ฒฝ์‚ฌํ•ญ์ด ์„œ๋น„์Šค์— ์ค‘๋Œ€ํ•œ ์˜ค๋ฅ˜๊ฐ€ ๋ฐœ์ƒํ•˜์ง€๋Š” ์•Š์ง€๋งŒ, ๋ฐ˜์˜์ด ๋˜์—ˆ์œผ๋ฉด ํ•˜๋Š” ์ฝ”๋ฉ˜ํŠธ์— ์ด ๋ผ๋ฒจ์„ ์‚ฌ์šฉํ•ฉ๋‹ˆ๋‹ค.
- ๋ฆฌ๋ทฐ ์š”์ฒญ์ž๋Š” ์ด ์˜๊ฒฌ์„ ์ˆ˜์šฉํ•˜๊ฑฐ๋‚˜ ํ•ฉ๋ฆฌ์ ์ธ ์˜๊ฒฌ์„ ๋“ค์–ด ๋…ผ์˜ํ•  ๊ฒƒ์„ ๊ถŒ์žฅํ•ฉ๋‹ˆ๋‹ค.

3: ์›ฌ๋งŒํ•˜๋ฉด ๋ฐ˜์˜ํ•ด ์ฃผ์„ธ์š” (Comment)
- ๋ฆฌ๋ทฐ์–ด๋Š” ๋‹น์žฅ ๋ฐ˜์˜์ด ๋˜์ง€ ์•Š์•„๋„ ๋˜์ง€๋งŒ ์›ฌ๋งŒํ•ด์„œ ๋ฐ˜์˜์ด ๋˜๋ฉด ์ข‹๊ฒ ๋‹ค๋Š” ์ฝ”๋ฉ˜ํŠธ์— ์ด ๋ผ๋ฒจ์„ ์‚ฌ์šฉํ•ฉ๋‹ˆ๋‹ค.
- ๋ฆฌ๋ทฐ ์š”์ฒญ์ž ์ด ์˜๊ฒฌ์„ ์ˆ˜์šฉํ•˜๊ฑฐ๋‚˜, ๋ฐ˜์˜ํ•  ์ˆ˜ ์—†๋Š” ์ด์œ ๋ฅผ ๋“ค์–ด ์„ค๋ช…ํ•˜๊ฑฐ๋‚˜, ๋‹ค์Œ์— ๋ฐ˜์˜ํ•  ๊ณ„ํš์„ ๋ช…์‹œ์ ์œผ๋กœ ํ‘œํ˜„ํ•  ๊ฒƒ์„ ๊ถŒ์žฅํ•ฉ๋‹ˆ๋‹ค.

4: ๋ฐ˜์˜ํ•ด๋„ ์ข‹๊ณ  ๋„˜์–ด๊ฐ€๋„ ์ข‹์Šต๋‹ˆ๋‹ค (Approve)
- ๋ฆฌ๋ทฐ์–ด๋Š” PR ๊ธฐ๋Šฅ์— ๋ฌธ์ œ๊ฐ€ ์—†๊ณ , ํ•œ ๋ฒˆ ๊ณ ๋ฏผํ•ด ๋ณผ ๋งŒํ•œ ์˜๊ฒฌ์— ๋Œ€ํ•ด ์ด ๋ผ๋ฒจ์„ ์‚ฌ์šฉํ•ฉ๋‹ˆ๋‹ค.
- ๋ฆฌ๋ทฐ ์š”์ฒญ์ž๋Š” ์ด ์˜๊ฒฌ์— ๋Œ€ํ•ด์„œ๋Š” ๋ณ„๋„์˜ ์‘๋‹ต์„ ๋‹ฌ์ง€ ์•Š์•„๋„ ๊ดœ์ฐฎ์Šต๋‹ˆ๋‹ค.
- ์˜๊ฒฌ์„ ๋ฐ˜์˜ํ•˜๋Š” ๊ฒŒ ์ข‹์„์ง€ ๊ณ ๋ฏผํ•ด ๋ณด๋Š” ์ •๋„๋ฉด ์ถฉ๋ถ„ํ•ฉ๋‹ˆ๋‹ค.

5: ๊ทธ๋ƒฅ ์‚ฌ์†Œํ•œ ์˜๊ฒฌ์ž…๋‹ˆ๋‹ค (Approve)
- ๋ฆฌ๋ทฐ์–ด๋Š” ์‚ฌ์†Œํ•œ ์˜๊ฒฌ์— ๋Œ€ํ•ด ์ด ๋ผ๋ฒจ์„ ์‚ฌ์šฉํ•ฉ๋‹ˆ๋‹ค.
- ๋ฆฌ๋ทฐ ์š”์ฒญ์ž๋Š” ์ด ์˜๊ฒฌ์— ๋Œ€ํ•ด ๋ณ„๋„์˜ ์‘๋‹ต์„ ๋‹ฌ์ง€ ์•Š์•„๋„ ๊ดœ์ฐฎ์Šต๋‹ˆ๋‹ค.

DO

p1; ์ด ๊ธฐ๋Šฅ์€ ์ž˜๋ชป๋œ ๊ธˆ์•ก์„ ๊ณ„์‚ฐํ•˜๊ฒŒ ๋ฉ๋‹ˆ๋‹ค.
p2) ์ด ์ฝ”๋“œ๋ฅผ ์ด๋ ‡๊ฒŒ ๋ณ€๊ฒฝ๋˜๋Š”๊ฒŒ ์–ด๋–จ๊นŒ์š”
p3, ์ฝ”๋“œ ๊ตฌ์„ฑ์„ ์ด๋ ‡๊ฒŒํ•˜๋ฉด ๊ฐ€๋…์„ฑ์ด ๋†’์•„์งˆ ๊ฒƒ ๊ฐ™์•„์š”.
p4: ์ด๋Ÿฐ ๋ฐฉ์‹์œผ๋กœ ์ž‘์„ฑ๋„ ๊ฐ€๋Šฅํ•  ๊ฒƒ ๊ฐ™์•„์š”.
p5. ์ด๋Ÿฐ ์Šคํƒ€์ผ๋„ ๊ดœ์ฐฎ์„๋“ฏํ•ด์š”.