Skip to content

Latest commit

ย 

History

240 Commits

Folders and files

NameName
Last commit message
Last commit date
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

๐Ÿš€ SWYP APP 4th Server

๐ŸŒฟ Git Flow Strategy

main (๋ฐฐํฌ/Production) ๋ธŒ๋žœ์น˜

  • ์ตœ์ข… ๋ฐฐํฌ ๊ฐ€๋Šฅํ•œ ์ƒํƒœ๋งŒ ์œ ์ง€
  • dev์—์„œ ์ถฉ๋ถ„ํžˆ ํ…Œ์ŠคํŠธ๋œ ๋‚ด์šฉ๋งŒ Merge

dev (๊ฐœ๋ฐœ/Dev) ๋ธŒ๋žœ์น˜

  • ๋‹ค์Œ ๋ฐฐํฌ๋ฅผ ์œ„ํ•ด ๊ฐœ๋ฐœ๋œ ๊ธฐ๋Šฅ๋“ค์ด ๋ชจ์ด๋Š” ๊ณณ
  • ํ•ญ์ƒ ๋นŒ๋“œ ๋ฐ ๋ฐฐํฌ ๊ฐ€๋Šฅํ•œ ์ƒํƒœ ์œ ์ง€

feat/#1 (๊ธฐ๋Šฅ/Feature) ๋ธŒ๋žœ์น˜

  • dev์—์„œ ๋ถ„๊ธฐํ•˜์—ฌ ์ƒˆ๋กœ์šด ๊ธฐ๋Šฅ ๊ฐœ๋ฐœ
  • ์ž‘์—… ์™„๋ฃŒ ํ›„ dev๋กœ PR

๐Ÿชต Branch Naming Convention

  • ํ˜•์‹: {header}/{issue-number}
  • ์˜ˆ์‹œ: feat/#5 fix/#11 refactor/#23

๐Ÿ’ก Issue & Pull Request (PR) Rules

โœ… Issue ์ฒดํฌ๋ฆฌ์ŠคํŠธ

  • Assignees์— ๋ณธ์ธ์„ ์„ ํƒํ–ˆ๋‚˜์š”?
  • ์ปจ๋ฒค์…˜์— ๋งž๋Š” Type ์„ ํƒ

โœ… PR ์ฒดํฌ๋ฆฌ์ŠคํŠธ

  • Reviewer์— ํŒ€์›๋“ค์„ ์„ ํƒํ–ˆ๋‚˜์š”?
  • Assignees์— ๋ณธ์ธ์„ ์„ ํƒํ–ˆ๋‚˜์š”?
  • ์ปจ๋ฒค์…˜์— ๋งž๋Š” Labels ์„ ํƒ
  • Development์— ์ด์Šˆ ์—ฐ๋™
  • Merge ๋ธŒ๋žœ์น˜ ํ™•์ธ (dev)
  • ์ปจ๋ฒค์…˜ ์ค€์ˆ˜
  • ๋กœ์ปฌ ์‹คํ–‰ ์‹œ ์—๋Ÿฌ ์—†์Œ
  • ํŒ€์›์—๊ฒŒ PR ๊ณต์œ 

๐Ÿ“ข ๊ณต์œ  ๋ฐ Merge ์กฐ๊ฑด

  • ํ™˜๊ฒฝ ์„ค์ • ํŒŒ์ผ ๋ณ€๊ฒฝ ์‹œ ํ•˜๋‹จ URL์— ์—…๋ฐ์ดํŠธ (application.yml, .env ๋“ฑ)
  • PR ์ƒ์„ฑ ์งํ›„ ๋””์Šค์ฝ”๋“œ์— ๋งํฌ ๊ณต์œ 
  • 1๋ช… ์ด์ƒ์ด ํ™•์ธ ํ›„ ๋ฆฌ๋ทฐ & Merge ์ง„ํ–‰
  • Merge: Squash and Merge ์‚ฌ์šฉ
    • ์ œ๋ชฉ ์˜ˆ์‹œ) #2 [chore] ์ด์Šˆ ๋ฐ PR ํ…œํ”Œ๋ฆฟ ์ถ”๊ฐ€
  • Merge ์™„๋ฃŒ ํ›„ ๋ธŒ๋žœ์น˜ ์ž๋™ ์‚ญ์ œ

โŒจ๏ธ Commit Message Convention

Category Type Description
๐Ÿš€ Feature โœจ Feat ์ƒˆ๋กœ์šด ๊ธฐ๋Šฅ ์ถ”๊ฐ€
๐Ÿš€ Feature ๐Ÿ’ฅ Breaking Change ํ•˜์œ„ ํ˜ธํ™˜์„ฑ ์—†๋Š” ํฐ API ๋ณ€๊ฒฝ
๐Ÿž Bug ๐Ÿ› Fix ๋ฒ„๊ทธ ์ˆ˜์ •
๐Ÿž Bug ๐Ÿš‘ Hotfix ๊ธด๊ธ‰ ์น˜๋ช…์  ๋ฒ„๊ทธ ์ˆ˜์ •
๐Ÿ›  Task ๐Ÿ”จ Chore ๋นŒ๋“œ ์—…๋ฌด, ํŒจํ‚ค์ง€ ์„ค์ •, .gitignore ์ˆ˜์ • ๋“ฑ
๐Ÿ›  Task ๐Ÿ‘ท CICD CI/CD ํŒŒ์ดํ”„๋ผ์ธ ๋ฐ ๋ฐฐํฌ ๊ด€๋ จ
๐Ÿ›  Task โ™ป๏ธ Refactor ์ฝ”๋“œ ๋ฆฌํŒฉํ† ๋ง (๊ธฐ๋Šฅ ๋ณ€๊ฒฝ ์—†์Œ)
๐Ÿ›  Task ๐Ÿ’„ Style ์ฝ”๋“œ ํฌ๋งทํŒ…, ์„ธ๋ฏธ์ฝœ๋ก  ๋ˆ„๋ฝ ๋“ฑ (๋กœ์ง ๋ณ€๊ฒฝ ์—†์Œ)
๐Ÿ›  Task ๐Ÿ’ก Comment ์ฃผ์„ ์ถ”๊ฐ€ ๋ฐ ๋ณ€๊ฒฝ
๐Ÿ›  Task ๐Ÿท๏ธ Rename ํŒŒ์ผ/ํด๋”๋ช… ์ˆ˜์ • ๋˜๋Š” ์ด๋™
๐Ÿ›  Task ๐Ÿ”ฅ Remove ํŒŒ์ผ ์‚ญ์ œ
๐Ÿ›  Task ๐ŸŽ‰ Init ํ”„๋กœ์ ํŠธ ์ดˆ๊ธฐ ์„ธํŒ…
๐Ÿ›  Task ๐Ÿ”€ Merge ๋ธŒ๋žœ์น˜ ๋ณ‘ํ•ฉ
๐Ÿ›  Task ๐Ÿงช Test ํ…Œ์ŠคํŠธ ์ฝ”๋“œ ์ถ”๊ฐ€/์ˆ˜์ •
๐Ÿ›  Task ๐Ÿ“š Docs ๋ฌธ์„œ ์ˆ˜์ • (README, Wiki ๋“ฑ)

๐Ÿ”„ Work Flow

1. ์ตœ์‹  ์ฝ”๋“œ ๋ถˆ๋Ÿฌ์˜ค๊ธฐ (Update)

  • ์ž‘์—… ์ „ ํ•ญ์ƒ dev ๋ธŒ๋žœ์น˜ ์ตœ์‹  ์ƒํƒœ ์œ ์ง€
  • ์ž‘์—… ์ค‘์ผ ๋•Œ (Stash ํ™œ์šฉ):
git stash               # ์ž‘์—… ์ค‘์ธ ์ฝ”๋“œ ์ž„์‹œ ์ €์žฅ
git pull origin dev     # ์›๊ฒฉ dev ๋ธŒ๋žœ์น˜ ๋‚ด์šฉ ๋‹น๊ฒจ์˜ค๊ธฐ
git stash pop           # ์ž„์‹œ ์ €์žฅํ–ˆ๋˜ ์ฝ”๋“œ ๋‹ค์‹œ ๊ฐ€์ ธ์˜ค๊ธฐ
  • ์ž‘์—… ์ค‘์ธ ๋‚ด์šฉ์ด ์—†์„ ๋•Œ:
git pull origin dev     # ์›๊ฒฉ dev ๋ธŒ๋žœ์น˜ ๋‚ด์šฉ ๋‹น๊ฒจ์˜ค๊ธฐ

2. ๋ธŒ๋žœ์น˜ ์ƒ์„ฑ

  • ์ž‘์—… ๋ชฉ์ ์— ๋งž๋Š” ๋…๋ฆฝ ๋ธŒ๋žœ์น˜ ์ƒ์„ฑ ํ›„ ์ž‘์—… ์‹œ์ž‘
# ํ˜•์‹: {type}/#{issue-number}
git checkout -b feat/#1

3. ์ž‘์—… ๋ฐ ์ปค๋ฐ‹ (Commit)

- IDE Commit UI ํ™œ์šฉ
- git add . ๋˜๋Š” ๋…ผ๋ฆฌ์  ๋‹จ์œ„ ์ปค๋ฐ‹
- ์ปค๋ฐ‹ ๋ฉ”์‹œ์ง€ : Commit Message Convention ์ค€์ˆ˜

4. ํ‘ธ์‹œ (Push)

  • ์ž‘์—… ์™„๋ฃŒ ํ›„ ๋ธŒ๋žœ์น˜๋ฅผ ์›๊ฒฉ ์ €์žฅ์†Œ์— ์—…๋กœ๋“œ
git push origin {์ƒ์„ฑํ•œ-๋ธŒ๋žœ์น˜-๋ช…}
# ์˜ˆ: git push origin feat/#1

๐Ÿ“‚ Project Structure

com.swyp.picke
โ”œโ”€โ”€ AppApplication.java
โ”‚
โ”œโ”€โ”€ domain
โ”‚
โ””โ”€โ”€ infra

About

๐Ÿ“• PICKE : ์ง€์‹์„ ๋“ฃ๊ณ  ์ƒ๊ฐ์„ Pickํ•˜๋Š” ์ฐธ์—ฌํ˜• ์ง€์‹ ํ”Œ๋žซํผ [Backend]

Resources

Stars

2 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages