Skip to content

Github Rules

yoonwoo123 edited this page Oct 29, 2020 · 3 revisions

์ตœ์ข…์ˆ˜์ •: 2020-10-29

BRANCH ๋‹จ์œ„

  • ๊ธฐ์ˆ ์„œ์˜ task ๋ณ„๋กœ ๋‚˜๋ˆ ์„œ ์ƒ์„ฑ
    • ์„ธ๋ถ€ task๋Š” ํ•ด๋‹น branch์—์„œ ๋‚˜๋ˆ  ์ƒ์„ธํ•˜๊ฒŒ ์ž‘์—…
  • master ๋ธŒ๋žœ์น˜๋Š” ๊ฑด๋“ค์ง€ ์•Š๊ธฐ
  • 5์ผ์ฐจ ๋ฐฐํฌ๋Š” dev ๋ธŒ๋žœ์น˜์—

COMMIT Rules

  1. Commit Message Type
type : (#์ด์Šˆ๋ฒˆํ˜ธ) subject
body (option)
Header Contents
Feat ์ƒˆ๋กœ์šด ๊ธฐ๋Šฅ ์ถ”๊ฐ€
Fix ๋ฒ„๊ทธ ์ˆ˜์ •
Docs ๋ฌธ์„œ ์ˆ˜์ •
Style ์ฝ”๋“œ ํฌ๋งทํŒ…, ์ฝ”๋“œ๋ณ€๊ฒฝ์ด ์—†๋Š” ๊ฒฝ์šฐ
Refactor ์ฝ”๋“œ ๋ฆฌํŽ™ํ† ๋ง
Test ํ…Œ์ŠคํŠธ ์ฝ”๋“œ, ๋ฆฌํŽ™ํ† ๋ง ํ…Œ์ŠคํŠธ ์ฝ”๋“œ ์ถ”๊ฐ€
Chore ๋นŒ๋“œ ์—…๋ฌด ์ˆ˜์ •, ํŒจํ‚ค์ง€ ๋งค๋‹ˆ์ € ์ˆ˜์ •
  1. commit ๋‹จ์œ„
  • ๊ธฐ์ˆ ์„œ์˜ description ๋ณ„๋กœ commit์„ ๋‚ ๋ฆฌ๋Š” ๊ฒƒ์œผ๋กœ ํ•œ๋‹ค

PR Rules

  • merge ์ „ PR์— ๋Œ“๊ธ€ ๋ฐ˜๋“œ์‹œ ๋‹ฌ์•„์ฃผ๊ธฐ
    • ์ƒ๋Œ€ ๋ถ€์„œ์ผ ๊ฒฝ์šฐ ์นญ์ฐฌ ๋“ฑ์˜ ๋Œ“๊ธ€
    • ๊ฐ™์€ ๋ถ€์„œ์ผ ๊ฒฝ์šฐ ๊ฐ„๋‹จํ•œ ์ฝ”๋“œ ๋ฆฌ๋ทฐ๋„ ํ•ด์ฃผ๊ธฐ
  • merge ํ›„ ๋ฐ˜๋“œ์‹œ ์ตœ์†Œํ•œ ๊ฐ™์€ ๋ถ€์„œ์—๊ฒŒ๋Š” ์•Œ๋ ค์ฃผ๊ธฐ
    • pull ๋ฐ›๊ณ  ์ถฉ๋Œ๋‚  ๊ฒฝ์šฐ, local์—์„œ ํ•ด๊ฒฐ๋ณด๋„๋ก ํ•˜๊ธฐ