Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. Weโ€™ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

๐Ÿ›  Commit Convention #1

Closed
doh3e opened this issue Dec 17, 2024 · 0 comments
Closed

๐Ÿ›  Commit Convention #1

doh3e opened this issue Dec 17, 2024 · 0 comments

Comments

@doh3e
Copy link
Owner

doh3e commented Dec 17, 2024

1. ์ปค๋ฐ‹ ๋ฉ”์„ธ์ง€ ๊ตฌ์กฐ

์ œ๋ชฉ(ํ•„์ˆ˜)

  • ํƒœ๊ทธ: ์ œ๋ชฉ ์œผ๋กœ ํ†ต์ผ
  • ํƒœ๊ทธ๋Š” ์˜์–ด๋กœ, ์ฒซ ๊ธ€์ž๋Š” ๋Œ€๋ฌธ์ž๋กœ ์ž‘์„ฑ
  • ๋งˆ์นจํ‘œ ๋ฏธ์‚ฌ์šฉ
  • 50์ž ์ดˆ๊ณผ ๊ธˆ์ง€
  • ์ตœ๋Œ€ํ•œ ๊ฐ„๊ฒฐํ•˜๊ฒŒ ํ•ต์‹ฌ๋งŒ ๋‹ด์•„์„œ

๋ณธ๋ฌธ(ํ•„์ˆ˜)

  • ๋ฌด์—‡์„ ์™œ ํ–ˆ๋Š”์ง€ ์ž‘์„ฑ (์ฝ”๋“œ๋ฅผ ๋ณ€๊ฒฝํ•œ ์ด์œ )
  • ํ•œ ์ค„๋‹น 72์ž ๋‚ด๋กœ
  • ์–ด๋–ป๊ฒŒ ๋ณ€๊ฒฝํ–ˆ๋Š”์ง€๋ฅผ ์ž‘์„ฑํ•˜๋Š” ๊ฒƒ์ด ์•„๋‹˜ XX
  • ์ œ๋ชฉ ์ž‘์„ฑ ํ›„ ๋‘ ์ค„ ์—”ํ„ฐ์นœ ๋‹ค์Œ ๋ณธ๋ฌธ ์ž…๋ ฅ

๊ผฌ๋ฆฌ๋ง(์„ ํƒ)

  • ์ด์Šˆ ํŠธ๋ž˜์ปค ์ข…๋ฅ˜: #์ด์Šˆ๋ฒˆํ˜ธ๋กœ ํ†ต์ผ
  • ์ด์Šˆ ํŠธ๋ž˜์ปค ์ข…๋ฅ˜ ๋ฐ ์œ ํ˜•
    • Fixes : ์ด์Šˆ ์ˆ˜์ • ์ค‘
    • Resolves : ์ด์Šˆ ํ•ด๊ฒฐ
    • Ref : ์ฐธ๊ณ  ์ด์Šˆ
    • Related to : ๊ด€๋ จ ์ด์Šˆ ๋ฒˆํ˜ธ

2. ์ปค๋ฐ‹ ์ปจ๋ฒค์…˜

๐Ÿ› ๏ธ ๊ธฐ๋Šฅ ๋ฐ ์ˆ˜์ • ๊ด€๋ จ

ํƒœ๊ทธ๋ช… ๋‚ด์šฉ
Feat ์ƒˆ ๊ธฐ๋Šฅ ์ถ”๊ฐ€
Fix ๋ฒ„๊ทธ ์ˆ˜์ •
Refactor ์ฝ”๋“œ ๊ตฌ์กฐ ๋ณ€๊ฒฝ
!HOTFIX ์น˜๋ช…์ ์ธ ๋ฒ„๊ทธ ์ˆ˜์ •
!BREAKING CHANGE API ๋ณ€๊ฒฝ

๐ŸŽจ ๋””์ž์ธ ๋ฐ ์™ธ๊ด€ ๋ณ€๊ฒฝ

ํƒœ๊ทธ๋ช… ๋‚ด์šฉ
Design UI ๋ณ€๊ฒฝ (CSS, HTML ๋“ฑ)
Style ์™ธ๊ด€ ์ˆ˜์ • ์—†๋Š” ๊ฒฝ์šฐ / ํฌ๋งท ๋ณ€๊ฒฝ

๐Ÿ“ ๋ฌธ์„œ ๋ฐ ์ฃผ์„ ๊ด€๋ จ

ํƒœ๊ทธ๋ช… ๋‚ด์šฉ
Docs ๋ฌธ์„œ ์ˆ˜์ •
Comment ์ฃผ์„ ๋ณ€๊ฒฝ

๐Ÿ”„ ํŒŒ์ผ ๋ฐ ํด๋” ๋ณ€๊ฒฝ

ํƒœ๊ทธ๋ช… ๋‚ด์šฉ
Rename ํŒŒ์ผ/ํด๋”๋ช… ์ˆ˜์ • ๋ฐ ์˜ฎ๊ธฐ๋Š” ์ž‘์—…
Remove only ํŒŒ์ผ ์‚ญ์ œ ์ž‘์—…

โš™๏ธ ๊ธฐํƒ€ ์ž‘์—…

ํƒœ๊ทธ๋ช… ๋‚ด์šฉ
Test ํ…Œ์ŠคํŠธ ๋ณ€๊ฒฝ
chore ๊ธฐํƒ€ ์„ค์ • ๋ฐ ์ž‘์—… ๊ด€๋ จ

3. ์•ˆ๋‚ด ๋ฐ ์˜ˆ์‹œ

  • git commit -m ์—์„œ ๋”ฐ์˜ดํ‘œ(")๋ฅผ ํ•˜๋‚˜๋งŒ ์ž…๋ ฅํ•˜๊ณ  ์—”ํ„ฐ๋ฅผ ๋ˆ„๋ฅด๋ฉด ๊ฐœํ–‰๋จ.
  • ์†Œ์…œ๋กœ๊ทธ์ธ ๊ธฐ๋Šฅ์„ ๊ตฌํ˜„ํ–ˆ์„ ๊ฒฝ์šฐ์˜ ์ปค๋ฐ‹ ๋ฉ”์„ธ์ง€ ์˜ˆ์‹œ)
git commit -m "Feat: ์†Œ์…œ ๋กœ๊ทธ์ธ ๊ธฐ๋Šฅ ์ถ”๊ฐ€

๋กœ๊ทธ์ธ ๊ฐ„์†Œํ™”๋ฅผ ์œ„ํ•œ ์นด์นด์˜ค, ๋„ค์ด๋ฒ„ ๋กœ๊ทธ์ธ ๊ธฐ๋Šฅ ์ถ”๊ฐ€

Ref #123
Related to: #456, #789"
@doh3e doh3e pinned this issue Dec 17, 2024
@doh3e doh3e closed this as completed Dec 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant