Skip to content

๐Ÿฑ๊นƒ ์ปจ๋ฒค์…˜๐Ÿฑ

JinHo Jeong edited this page Sep 11, 2023 · 2 revisions

Commit Convention

- [CHORE] : ๋™์ž‘์— ์˜ํ–ฅ ์—†๋Š” ์ฝ”๋“œ or ๋ณ€๊ฒฝ ์—†๋Š” ๋ณ€๊ฒฝ์‚ฌํ•ญ(์ฃผ์„ ์ถ”๊ฐ€ ๋“ฑ)
- [FEAT] : ์ƒˆ๋กœ์šด ๊ธฐ๋Šฅ ๊ตฌํ˜„
- [ADD] : Feat ์ด์™ธ์˜ ๋ถ€์ˆ˜์ ์ธ ์ฝ”๋“œ ์ถ”๊ฐ€, ๋ผ์ด๋ธŒ๋Ÿฌ๋ฆฌ ์ถ”๊ฐ€, ์ƒˆ๋กœ์šด ํŒŒ์ผ ์ƒ์„ฑ
- [FIX] : ๋ฒ„๊ทธ, ์˜ค๋ฅ˜ ํ•ด๊ฒฐ
- [DOCS] : README๋‚˜ WIKI ๋“ฑ์˜ ๋ฌธ์„œ ์ˆ˜์ •
- [CORRECT] : ์ฃผ๋กœ ๋ฌธ๋ฒ•์˜ ์˜ค๋ฅ˜๋‚˜ ํƒ€์ž…์˜ ๋ณ€๊ฒฝ, ์ด๋ฆ„ ๋ณ€๊ฒฝ์‹œ
- [REFACTOR] : ์ „๋ฉด ์ˆ˜์ •
- [STYLE] : Xml, Ui ์ˆ˜์ • 
- [MERGE]: ๋‹ค๋ฅธ ๋ธŒ๋žœ์น˜์™€ ๋ณ‘ํ•ฉ

ex ) git commit -m "#1 [FEAT] ํšŒ์›๊ฐ€์ž… ๊ธฐ๋Šฅ ์™„๋ฃŒ"

Branch Convention

- [develop] : ์ตœ์ข… ๋ฐฐํฌ
- [feature] : ๊ธฐ๋Šฅ ์ถ”๊ฐ€
- [fix] : ์—๋Ÿฌ ์ˆ˜์ •, ๋ฒ„๊ทธ ์ˆ˜์ •
- [docs] : README, ๋ฌธ์„œ
- [refactor] : ์ฝ”๋“œ ๋ฆฌํŽ™ํ† ๋ง (๊ธฐ๋Šฅ ๋ณ€๊ฒฝ ์—†์ด ์ฝ”๋“œ๋งŒ ์ˆ˜์ •ํ•  ๋•Œ)
- [chore] : gradle ์„ธํŒ…, ์œ„์˜ ๊ฒƒ ์ด์™ธ์— ๊ฑฐ์˜ ๋ชจ๋“  ๊ฒƒ

ex) feature/tgyuu/#issue

Git Flow

๊ธฐ๋ณธ์ ์œผ๋กœ Git Flow ์ „๋žต์„ ์ด์šฉํ•œ๋‹ค. ์ž‘์—… ์‹œ์ž‘ ์‹œ ์„ ํ–‰๋˜์–ด์•ผ ํ•  ์ž‘์—…์€ ๋‹ค์Œ๊ณผ ๊ฐ™๋‹ค.

1. Issue๋ฅผ ์ƒ์„ฑํ•œ๋‹ค.
2. feature Branch๋ฅผ ์ƒ์„ฑํ•œ๋‹ค.
3. Add - Commit - Push - Pull Request ์˜ ๊ณผ์ •์„ ๊ฑฐ์นœ๋‹ค.
4. Pull Request๊ฐ€ ์ž‘์„ฑ๋˜๋ฉด ์ž‘์„ฑ์ž ์ด์™ธ์˜ ๋‹ค๋ฅธ ํŒ€์›์ด Code Review๋ฅผ ํ•œ๋‹ค.
5. Code Review๊ฐ€ ์™„๋ฃŒ๋˜๋ฉด Pull Request ์ž‘์„ฑ์ž๊ฐ€ develop Branch๋กœ merge ํ•œ๋‹ค.
6. merge๋œ ์ž‘์—…์ด ์žˆ์„ ๊ฒฝ์šฐ, ๋‹ค๋ฅธ ๋ธŒ๋žœ์น˜์—์„œ ์ž‘์—…์„ ์ง„ํ–‰ ์ค‘์ด๋˜ ๊ฐœ๋ฐœ์ž๋Š” ๋ณธ์ธ์˜ ๋ธŒ๋žœ์น˜๋กœ merge๋œ ์ž‘์—…์„ Pull ๋ฐ›์•„์˜จ๋‹ค.
7. ์ข…๋ฃŒ๋œ Issue์™€ Pull Request์˜ Label๊ณผ Project๋ฅผ ๊ด€๋ฆฌํ•œ๋‹ค.

Issue Template


๐Ÿ“‘ ์ž‘์—… ์‚ฌํ•ญ

์ž‘์—…ํ•  ๋‚ด์šฉ ์„ค๋ช…

To-do

  • todo
  • todo

#โœ”๏ธ ๊ธฐํƒ€์‚ฌํ•ญ

Git Template


1. ๐Ÿ“„ ๊ด€๋ จ๋œ ์ด์Šˆ ๋ฐ ์†Œ๊ฐœ

2. ๐Ÿ”ฅ๋ณ€๊ฒฝ๋œ ์ 

3. ๐Ÿ“ธ ์Šคํฌ๋ฆฐ์ƒท(์„ ํƒ)

4. ๐Ÿ’ก์•Œ๊ฒŒ๋œ ํ˜น์€ ๊ถ๊ธˆํ•œ ์‚ฌํ•ญ๋“ค