Skip to content
This repository was archived by the owner on Sep 27, 2023. It is now read-only.

Team Rule

Jaeyeob Kim edited this page May 3, 2022 · 1 revision

โฐ๐Ÿ‘ฎ๐Ÿปโ€โ™‚๏ธTeam Rules

๐Ÿ’ก Code convention : [BE] ์ˆ˜์ •๋œ Google Java Style Guide ๋ฅผ ๋”ฐ๋ฆ…๋‹ˆ๋‹ค.

๐Ÿ’ก Code convention : [FE] prettier ์‚ฌ์šฉ..?

๐Ÿ’ก Commit message : ์œ ๋‹ค์‹œํ‹ฐ ์ปค๋ฐ‹ ์ปจ๋ฒค์…˜์„ ๋”ฐ๋ฆ…๋‹ˆ๋‹ค. (ํ•œ๊ธ€๋ฒˆ์—ญ)

๐Ÿ’ก Issue Sharing Guide

  • ์งˆ๋ฌธ์ด ์žˆ๊ฑฐ๋‚˜ ๋„์›€์ด ํ•„์š”ํ•œ ๊ฒฝ์šฐ ๋ง์„ค์ด์ง€๋Š” ์•Š์ง€๋งŒ ์ƒ๊ฐ์„ ์ถฉ๋ถ„ํžˆ ํ•œ ํ›„ ์งˆ๋ฌธํ•˜๊ธฐ
  • ๋‹ต๋ณ€์€ ์ตœ์„ ์„ ๋‹คํ•˜์—ฌ ํ•ด์ฃผ๊ธฐ

๐Ÿค Git

โ—๏ธ Git Rule

  • feature ๋ธŒ๋žœ์น˜(branch)์—์„œ ์ž‘์—…
  • develop์—์„œ ๋ธŒ๋žœ์น˜ ์ƒ์„ฑ
  • develop๊ณผย master์— ์ง์ ‘ ํ‘ธ์‹œ X / ํ’€ ๋ฆฌํ€˜์ŠคํŠธ O
  • Pull Request ์ƒ์„ฑ ์ „ ๋ฆฌ๋ฒ ์ด์Šคํ•˜๋Š” ๋™์•ˆ ์ž ์žฌ์ ์ธ ์ถฉ๋Œ ์ œ๊ฑฐ
  • ๋ณ‘ํ•ฉ ํ›„, ๋กœ์ปฌ๊ณผ ์›๊ฒฉ์— ์žˆ๋Š” feature ๋ธŒ๋žœ์น˜ ์‚ญ์ œ
  • feature ๋ธŒ๋žœ์น˜์˜ ๋นŒ๋“œ ๊ฒ€์‚ฌ / ์ฝ”๋“œ ์Šคํƒ€์ผ ์ฒดํฌ ๋“ฑ ๋ชจ๋“  ํ…Œ์ŠคํŠธ ํ†ต๊ณผ ๊ฒ€์ฆ ํ›„ Pull Request
  • .gitignore ์‚ฌ์šฉ
  • develop๊ณผย masterย ๋ธŒ๋žœ์น˜ ๋ณดํ˜ธ

โ˜‘๏ธ Commit

๐Ÿ’ก Commit Message Rule

  • ๋™๋ช…์‚ฌX ๊ด€์‚ฌX ๋ช…์‚ฌO
  • ๋ถ€์ •๋ฌธ Don't ์‚ฌ์šฉ
  • ์ค„ ๋ฐ”๊ฟˆ์„ ํ†ตํ•ด์„œ ์ œ๋ชฉ๊ณผ ๋ณธ๋ฌธ์„ ๊ตฌ๋ถ„
  • ์ œ๋ชฉ์— ๋Œ€๋ฌธ์ž๋ฅผ ์‚ฌ์šฉ
  • ์ œ๋ชฉ์„ ๋งˆ์นจํ‘œ ์‚ฌ์šฉ X
  • ์ œ๋ชฉ์— ๋ช…๋ น๋ฒ•(imperative mood) ์‚ฌ์šฉ
  • ์˜คํƒ€ ์ˆ˜์ • = Fix typo

Work Flow

๐Ÿ‘คLeader

  1. ์ดˆ๊ธฐ ๋ ˆํฌ์ง€ํ† ๋ฆฌ๋ฅผ ๋ฐ›์•„ local์— ํด๋ก 
  2. master ๋ธŒ๋žœ์น˜์—์„œ ์ดˆ๊ธฐ ์„ธํŒ…
  3. ๊ทธ๋Œ€๋กœ dev ๋ธŒ๋žœ์น˜ ์ƒ์„ฑ
  4. dev์— ํ‘ธ์‹œ ํ›„ master์— merge

๐Ÿ‘ฅ Member

  1. fork ํ›„ ๋กœ์ปฌ์— clone
  2. dev ๋ธŒ๋žœ์น˜๋ฅผ ๊ธฐ๋ฐ˜์œผ๋กœ feature ๋ธŒ๋žœ์น˜ ์ƒ์„ฑ
  3. feature ๋ธŒ๋žœ์น˜์—์„œ ์™„์„ฑ๋˜๋ฉด ํ•ด๋‹น ๋ธŒ๋žœ์น˜๋กœ ํ‘ธ์‹œ
  4. P/R์„ upstream dev์— ์š”์ฒญ
  5. (์—…๋ฐ์ดํŠธ๊ฐ€ ์žˆ์„ ๋•Œ) upstream์œผ๋กœ๋ถ€ํ„ฐ pullํ•˜์—ฌ ์ตœ์‹ ํ™”๋œ ์ •๋ณด ๋™๊ธฐํ™”

๐ŸŒณ Branch - ๋ธŒ๋žœ์น˜ ์ด๋ฆ„์ด๋‚˜ ๊ฐ ๋ธŒ๋žœ์น˜ ๋ณ„ ๊ทœ๋ชจ

dev / feature-login-component

dev / landing-page / feature-login-component

Clone this wiki locally