Skip to content

gdg-yonsei/coke-poke-be

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

4 Commits
ย 
ย 
ย 
ย 

Repository files navigation

Coke-Poke

Branch / PR Guide

  • ๋ณธ์ธ์˜ ๋Œ€ํ‘œ ๋ธŒ๋žœ์น˜๋ฅผ ์ƒ์„ฑํ•ฉ๋‹ˆ๋‹ค (Ex. ๋ณธ์ธ์˜ ์ด๋ฆ„)
  • ์ดํ›„, ๊ฐ Step ๋งˆ๋‹ค ํ•ด๋‹น ๋ธŒ๋žœ์น˜๋ฅผ ๋ฒ ์ด์Šค๋กœ ํ•˜๋Š” ์ƒˆ๋กœ์šด ๋ธŒ๋žœ์น˜๋ฅผ ์ƒ์„ฑํ•ฉ๋‹ˆ๋‹ค
    • ์ด ๊ฒฝ์šฐ, ๊ฐ ๋ธŒ๋žœ์น˜์˜ ์ด๋ฆ„์€ feature/{๋Œ€ํ‘œ ๋ธŒ๋žœ์น˜ ์ด๋ฆ„}_step1 ๊ณผ ๊ฐ™์€ ๋ฐฉ์‹์œผ๋กœ ์ƒ์„ฑํ•ฉ๋‹ˆ๋‹ค
    • PR์€ ๋Œ€ํ‘œ ๋ธŒ๋žœ์น˜ <- Step ๋ธŒ๋žœ์น˜๋กœ ์ง„ํ–‰ํ•ฉ๋‹ˆ๋‹ค
  • PR ์„ ๋จธ์ง€ํ•˜๊ธฐ ์œ„ํ•ด์„  ํ•„์ˆ˜์ ์œผ๋กœ 1๊ฐœ ์ด์ƒ์˜ Approve๋ฅผ ๋ฐ›์•„์•ผ ํ•ฉ๋‹ˆ๋‹ค. PR์„ ์˜ฌ๋ฆฌ์‹  ์ดํ›„์—” ๋ฆฌ๋ทฐ์–ด ์ง€์ • ๋ถ€ํƒ๋“œ๋ฆฝ๋‹ˆ๋‹ค (@jyoo0515, ๋ณธ์ธ์˜ ๋ฆฌ๋ทฐ์–ด)
  • ๋ชจ๋“  step ์€ ํ…Œ์ŠคํŠธ ์ฝ”๋“œ๋ฅผ ํฌํ•จํ•ด์•ผ ํ•ฉ๋‹ˆ๋‹ค
  • ํ˜„ ๋‹จ๊ณ„์—์„œ CD ๊นŒ์ง€๋Š” ํ•„์š” ์—†์ง€๋งŒ CI ๋Š” ๋„์ž…ํ•ด์„œ ํ…Œ์ŠคํŠธ ์ฝ”๋“œ์™€ ์ฝ”๋“œ ์Šคํƒ€์ผ(๋ฆฐํŠธ)์ด ํ†ต๊ณผํ•˜๋Š”์ง€ ํ™•์ธํ•ด์ฃผ์„ธ์š”
  • (optional) Webhook ์„ ๋„์ž…ํ•ด์„œ CI ๊ฒฐ๊ณผ, Test Coverage ๋ถ„์„ ๊ฒฐ๊ณผ, PR ์š”์ฒญ, ๋ฆฌ๋ทฐ ์ฝ”๋ฉ˜ํŠธ ๋“ฑ์— ๋Œ€ํ•ด Discord ๋ฉ”์‹œ์ง€๊ฐ€ ์˜ฌ ์ˆ˜ ์žˆ๋„๋ก ์ ์šฉํ•ด๋ณด๋ฉด ์ข‹์„ ๊ฒƒ ๊ฐ™์Šต๋‹ˆ๋‹ค

Review Guide

๋ฆฌ๋ทฐ๋ฅผ ํ•˜๋Š” ์ž…์žฅ

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

๋ฆฌ๋ทฐ๋ฅผ ๋ฐ›๋Š” ์ž…์žฅ

  • ํ•ด๋‹น ํ”„๋กœ์ ํŠธ์˜ ๊ฒฝ์šฐ ๊ฐ step ๋ณ„๋กœ ํ•ด์•ผํ•  ์ผ์ด ์ •ํ•ด์ ธ ์žˆ์ง€๋งŒ ๊ธฐ๋ณธ์ ์œผ๋กœ PR ์„ ์—ด๋•Œ๋Š” ๋ณธ์ธ์ด ์ž‘์—…ํ•œ ๋‚ด์šฉ์„ ์ดํ•ดํ•˜๊ธฐ ์‰ฝ๊ฒŒ ์„ค๋ช…ํ•ด๋‘ฌ์•ผ ํ•ฉ๋‹ˆ๋‹ค. ๋ฆฌ๋ทฐ์–ด๊ฐ€ ๋งฅ๋ฝ ํŒŒ์•…์„ ์ˆ˜์›”ํ•˜๊ฒŒ ํ•  ์ˆ˜ ์žˆ๋„๋ก PR ์˜ description ์„ ์ƒ์„ธํ•˜๊ฒŒ ์ ์–ด์ฃผ์„ธ์š”
  • ๋ชจ๋“  ๋ฆฌ๋ทฐ๋Š” ์ œ์•ˆ ์‚ฌํ•ญ์ž…๋‹ˆ๋‹ค. ๋ฆฌ๋ทฐ ๋‚ด์šฉ์„ ๊ตณ์ด ๋ฐ˜์˜ํ•  ํ•„์š”๊ฐ€ ์—†๋‹ค๊ณ  ์ƒ๊ฐ๋˜๋ฉด ์•ˆํ•ด๋„ ๋ฉ๋‹ˆ๋‹ค๋งŒ ๊ทธ ์ด์œ ๋ฅผ ํ•จ๊ป˜ ์ฝ”๋ฉ˜ํŠธ๋กœ ๋‹ฌ์•„์ฃผ์„ธ์š”.
  • ๋ฆฌ๋ทฐ์–ด๋Š” ๋” ๋‚˜์€ ์ฝ”๋“œ๋ฅผ ์œ„ํ•œ ์ œ์•ˆ์„ ํ•˜๋Š” ๊ฒƒ ๋ฟ์ด๋ผ๋Š” ์ƒ๊ฐ์„ ๊ฐ–๊ณ  ๋ฆฌ๋ทฐ์–ด์™€ ๋งˆ์ฐฌ๊ฐ€์ง€๋กœ ๋ถ€๋“œ๋Ÿฌ์šด ์ปค๋ฎค๋‹ˆ์ผ€์ด์…˜์— ์‹ ๊ฒฝ ์จ์ฃผ์„ธ์š”.
  • ๋ฆฌ๋ทฐ๋ฅผ ๋ฐ›์€ ๋’ค ๋ฐ˜์˜์„ ํ–ˆ๋‹ค๋ฉด ํ•ด๋‹น ์ฝ”๋ฉ˜ํŠธ์— commit hash ๋ฅผ ๋‚จ๊ฒจ์ฃผ์„ธ์š”. ๋ฆฌ๋ทฐ์–ด๊ฐ€ ๋ฐ˜์˜ ๋‚ด์šฉ์„ ํ•œ๋ฒˆ์— ํ™•์ธํ•  ์ˆ˜ ์žˆ์–ด ๋ฆฌ๋ทฐ๊ฐ€ ์ˆ˜์›”ํ•ด์ง‘๋‹ˆ๋‹ค
  • ๋ฆฌ๋ทฐ์–ด์˜ ์ฝ”๋ฉ˜ํŠธ๋ฅผ ๋ชจ๋‘ ๋ฐ˜์˜ํ–ˆ๊ฑฐ๋‚˜ ๋‹ต์žฅ์„ ํ–ˆ๋‹ค๋ฉด Re-request review ๋ฒ„ํŠผ์„ ๋ˆŒ๋Ÿฌ์„œ ๋ฆฌ๋ทฐ์–ด์—๊ฒŒ ์ž‘์—…์ด ์™„๋ฃŒ๋๋‹ค๋Š” ๋…ธํ‹ฐ๋ฅผ ์ฃผ์„ธ์š”

Git Convention

ํฌ๋งท

type: subject;

body;

type

  • ํ•˜๋‚˜์˜ ์ปค๋ฐ‹์— ์—ฌ๋Ÿฌ ํƒ€์ž…์ด ์กด์žฌํ•˜๋Š” ๊ฒฝ์šฐ ์ƒ์œ„ ์šฐ์„ ์ˆœ์œ„์˜ ํƒ€์ž…์„ ์‚ฌ์šฉํ•œ๋‹ค.
  • fix: ๋ฒ„์Šค ํ”ฝ์Šค
  • feat: ์ƒˆ๋กœ์šด ๊ธฐ๋Šฅ ์ถ”๊ฐ€
  • refactor: ๋ฆฌํŒฉํ† ๋ง (๋ฒ„๊ทธํ”ฝ์Šค๋‚˜ ๊ธฐ๋Šฅ์ถ”๊ฐ€์—†๋Š” ์ฝ”๋“œ๋ณ€ํ™”)
  • docs: ๋ฌธ์„œ๋งŒ ๋ณ€๊ฒฝ
  • style: ์ฝ”๋“œ์˜ ์˜๋ฏธ๊ฐ€ ๋ณ€๊ฒฝ ์•ˆ ๋˜๋Š” ๊ฒฝ์šฐ (๋„์–ด์“ฐ๊ธฐ, ํฌ๋งทํŒ…, ์ค„๋ฐ”๊ฟˆ ๋“ฑ)
  • test: ํ…Œ์ŠคํŠธ์ฝ”๋“œ ์ถ”๊ฐ€/์ˆ˜์ •
  • chore: ๋นŒ๋“œ ํ…Œ์ŠคํŠธ ์—…๋ฐ์ดํŠธ, ํŒจํ‚ค์ง€ ๋งค๋‹ˆ์ €๋ฅผ ์„ค์ •ํ•˜๋Š” ๊ฒฝ์šฐ (ํ”„๋กœ๋•์…˜ ์ฝ”๋“œ ๋ณ€๊ฒฝ X)

subject

  • ์ œ๋ชฉ์€ 50๊ธ€์ž๋ฅผ ๋„˜์ง€ ์•Š๋„๋ก ํ•œ๋‹ค.
  • ๊ฐœ์กฐ์‹ ๊ตฌ๋ฌธ ์‚ฌ์šฉ
    • ์ค‘์š”ํ•˜๊ณ  ํ•ต์‹ฌ์ ์ธ ์š”์†Œ๋งŒ ๊ฐ„์ถ”๋ ค์„œ (ํ•ญ๋ชฉ๋ณ„๋กœ ๋‚˜์—ดํ•˜๋“ฏ์ด) ํ‘œํ˜„
  • ๋งˆ์ง€๋ง‰์— ํŠน์ˆ˜๋ฌธ์ž๋ฅผ ๋„ฃ์ง€ ์•Š๋Š”๋‹ค. (๋งˆ์นจํ‘œ, ๋А๋‚Œํ‘œ, ๋ฌผ์Œํ‘œ ๋“ฑ)

body (optional)

  • ๊ฐ ๋ผ์ธ๋ณ„๋กœ balled list๋กœ ํ‘œ์‹œํ•œ๋‹ค.
    • ์˜ˆ์‹œ) - AA
  • ๊ฐ€๋Šฅํ•˜๋ฉด ํ•œ์ค„๋‹น 72์ž๋ฅผ ๋„˜์ง€ ์•Š๋„๋ก ํ•œ๋‹ค.
  • ๋ณธ๋ฌธ์˜ ์–‘์— ๊ตฌ์• ๋ฐ›์ง€ ์•Š๊ณ  ์ตœ๋Œ€ํ•œ ์ƒ์„ธํžˆ ์ž‘์„ฑ
  • โ€œ์–ด๋–ป๊ฒŒโ€ ๋ณด๋‹ค๋Š” โ€œ๋ฌด์—‡์„" โ€œ์™œโ€ ๋ณ€๊ฒฝํ–ˆ๋Š”์ง€ ์„ค๋ช…ํ•œ๋‹ค.

About

GDSC Yonsei Backend Part Project

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •