Skip to content

team convention

Eugine Park edited this page Jul 11, 2021 · 4 revisions

Git branch ์ „๋žต

๋ธŒ๋žœ์น˜ ์—ญํ•  ๊ทœ์น™
main ์ฃผ์š” ๋ธŒ๋žœ์น˜(์šด์˜ ํ™˜๊ฒฝ) ๋‹จ์ผ ๋ธŒ๋žœ์น˜. ์‚ญ์ œํ•˜์ง€ ์•Š๋Š”๋‹ค.
develop ๊ฐœ๋ฐœ ํ™˜๊ฒฝ(๋ฒ ํƒ€ ๋ฐฐํฌ์šฉ) ์ตœ์‹  main ๋ธŒ๋žœ์น˜์—์„œ ๋งŒ๋“ ๋‹ค. main ๋ธŒ๋žœ์น˜์— ๋จธ์ง€ํ•˜๋ฉด ์ตœ์‹ ํ™”๋œ ์ƒํƒœ๋ฅผ ์œ ์ง€ํ•œ๋‹ค.
feature ์‹ ๊ทœ ๊ธฐ๋Šฅ ๊ฐœ๋ฐœ ์ตœ์‹  develop ๋ธŒ๋žœ์น˜์—์„œ ๋งŒ๋“ ๋‹ค. develop ๋ธŒ๋žœ์น˜์— ๋จธ์ง€ํ•˜๋ฉด ์‚ญ์ œํ•œ๋‹ค.
fix ๊ฐœ๋ฐœ ํ™˜๊ฒฝ ๋ฒ„๊ทธ ์ˆ˜์ • ์ตœ์‹  develop ๋ธŒ๋žœ์น˜์—์„œ ๋งŒ๋“ ๋‹ค. develop ๋ธŒ๋žœ์น˜์— ๋จธ์ง€ํ•˜๋ฉด ์‚ญ์ œํ•œ๋‹ค.

Commit Convention

type

  • feat: ์ƒˆ๋กœ์šด ๊ธฐ๋Šฅ ์ถ”๊ฐ€
  • fix: ๋ฒ„๊ทธ ์ˆ˜์ •
  • refactor: ์ฝ”๋“œ ๋ฆฌํŒฉํ† ๋ง
  • docs: ๋ฌธ์„œ ๊ด€๋ จ
  • test : ํ…Œ์ŠคํŠธ ์ถ”๊ฐ€ ๋ฐ ์ˆ˜์ •
  • etc: ๋นŒ๋“œ ๊ด€๋ จ, CI ์„ค์ •, ์Šคํƒ€์ผ ์„ค์ •, ๊ทธ ์™ธ

PR Convention

  • ์ œ๋ชฉ : ์ œ๋ชฉ์€ ์ด์Šˆ์™€ ๋™์ผํ•˜๊ฒŒ
  • ๋‚ด์šฉ : 1. ์ž‘์—…๋‚ด์šฉ 2. ์ฃผ์˜์‚ฌํ•ญ
  • PR ์ž‘์„ฑ ์‹œ ๋ฆฌ๋ทฐ์–ด ํ• ๋‹น
  • ํ”„๋กœ์ ํŠธ ํ• ๋‹น
  • approve, request change ๋“ฑ์˜ ๋ฆฌ๋ทฐ๋ฅผ ๋‚จ๊ธธ ๋•Œ์—๋Š” ๋‚จ๊ธฐ๊ณ  ๋‚˜์„œ ์นดํ†ก์— ์•Œ๋ ค์ฃผ๊ธฐ
  • ๋ชจ๋‘์—๊ฒŒ ๋ฆฌ๋ทฐ๋ฅผ ๋ฐ›์œผ๋ฉด ์ง์ ‘ ๋ณธ์ธ์˜ PR ๋จธ์ง€, ๋ธŒ๋žœ์น˜ ์‚ญ์ œ

๋ณด๊ณ  ๋˜ ๋ณด๊ณ  (๋ณด๋˜๋ณด)


Documents ๐Ÿ“ƒ


ํŒ€ ๊ทœ์น™ ๐Ÿค

Code Convention

๊ธฐ์ˆ  ๊ณต์œ  ๐Ÿธ


๋ฐ์ผ๋ฆฌ ๋ฏธํŒ… ๋ฐ ํšŒ์˜๋ก ๐Ÿณ

2์ฐจ ~ 4์ฐจ ํšŒ์˜ ๋ฐ ๋ฐ์ผ๋ฆฌ ๋ฏธํŒ…์€ ๋””์Šค์ฝ”๋“œ์—์„œ ์ง„ํ–‰๋˜์–ด ์ด์Šˆ๋กœ ๋ฐ˜์˜๋˜์—ˆ์Šต๋‹ˆ๋‹ค.

์ดํ›„ ํšŒ์˜ ๋ฐ ๋ฐ์ผ๋ฆฌ ๋ฏธํŒ…์€ ๋””์Šค์ฝ”๋“œ์—์„œ ์ง„ํ–‰๋˜์–ด ์ด์Šˆ๋กœ ๋ฐ˜์˜๋˜์—ˆ์Šต๋‹ˆ๋‹ค.

Clone this wiki locally