-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy path.gitmessage.txt
86 lines (82 loc) ยท 3.62 KB
/
.gitmessage.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
################# (์์ Type ์์ฑ)
# 1. Type (๋๋ถ๋ฅ)
# - [FE]: ํ๋ก ํธ์๋ ๊ด๋ จ ๋๋ถ๋ฅ
# - [BE]: ๋ฐฑ์๋ ๊ด๋ จ ๋๋ถ๋ฅ
# - [INFRA]: ์ธํ๋ผ ๊ด๋ จ ๋๋ถ๋ฅ
# - [MAIN]: ๋ฉ์ธ ๊ด๋ จ ๋๋ถ๋ฅ
# [{Type}] {Subject Type} #{์ด์ ๋ฒํธ}: {Subject}
# ex) [FE] feat #21: ํ์์ ๋ณด ์์ ์ปดํฌ๋ํธ ์ถ๊ฐ
# ex) [BE] feat #22: ํ์์ ๋ณด ์์ API ๊ตฌํ
# ex) [INFRA] deploy #23: ๋ฐฑ์๋ Jenkinsfile ์์ฑ
# ex) [MAIN] docs #24: ํฌํ
๋งค๋ด์ผ ์์ฑ
################
# 1-1. Subject Type
# - design: UI์ ๋ณ๊ฒฝ์ฌํญ์ด ์๋ ๊ฒฝ์ฐ
# - deploy: ๋ฐฐํฌ์ ๊ด๋ จ๋ ์ปค๋ฐ
# - docs: readme.md, json ํ์ผ ๋ฑ ์์
# - feat: ์๋ก์ด ๊ธฐ๋ฅ ๊ตฌํ
# - fix: ์ค๋ฅ ์์
# - refactor: ์ฝ๋ ๋ฆฌํฉํ ๋ง
# - setting: ๊ฐ๋ฐ ํ๊ฒฝ ๊ตฌ์ถ๊ณผ ๊ด๋ จ๋ ์ปค๋ฐ
# - style: ์ฝ๋์ ๋ณํ๊ฐ ์๋ ์์ ( ๋ณ์๋ช
, ์คํ, ์ธ๋ฏธ์ฝ๋ก ๋ฑ)
# - test: ํ
์คํธ์ฝ๋ ๊ด๋ จ ์ปค๋ฐ
# 1-2. Subject
# - 50๊ธ์๋ฅผ ๋์ง ์๋๋ก ์์ฑ
# - ๋ง์นจํ ๋ฐ ํน์๊ธฐํธ๋ ์ฌ์ฉํ์ง ์์ต๋๋ค.
# - ์ ๋ชฉ์ ์์ ํ ์์ ํ ๋ฌธ์ฅ์ด ์๋๋ผ, ๊ฐ๊ฒฐํ๊ณ ์์ ์ ์ธ ์์ ์ ์ํด ๊ฐ์กฐ์ ๊ตฌ๋ฌธ์ ์ฌ์ฉ
################(์๋๋ ๊ณต๋ฐฑ ์ ์ง : Type๊ณผ Body์ ๊ตฌ๋ถ)
#################
# 1-2. Subject (์ ๋ชฉ)
# - 50๊ธ์ ๋์ง ์๋๋ก ์์ฑ
# - ๋ง์นจํ ๋ฐ ํน์๊ธฐํธ ์ฌ์ฉ ๊ธ์ง
# - ์ ๋ชฉ์ ์์ ํ ์์ ํ ๋ฌธ์ฅ์ด ์๋๋ผ, ๊ฐ๊ฒฐํ ์์ ์ ์ํด ๊ฐ์กฐ์ ๊ตฌ๋ฌธ ์ฌ์ฉ
#################
################# (์์ Body ์์ฑ)
# 2. Body (๋ด์ฉ)
# ์ ํ ์ฌํญ์ผ๋ก ์์
๋ด์ฉ์ด ๋ณต์กํ๊ฑฐ๋ ์์ธํ ๋ด์ฉ์ ๋จ๊ฒจ์ผ ํ๋ ๊ฒฝ์ฐ์๋ง ์์ฑ
# ex)
# - ์ด๋ฏธ์ง ์
๋ก๋ ๊ธฐ๋ฅ ์ถ๊ฐ
# - ํ์ ์ ๋ณด ์์ api ์ฐ๋
#################
# 2-1. Body ์์ฑ ๊ท์น
# - ๋ณธ๋ฌธ์ 72์ ๋ด๋ก ์์ฑ
# - ํ์ํ ๊ฒฝ์ฐ ์ฌ๋ฌ์ค๋ก๋ ์์ฑ ๊ฐ๋ฅ
# - ์ฌ๋ฌ ์ค์ ๋ฉ์์ง๋ฅผ ์์ฑํ ๋ "-"๋ก ๊ตฌ๋ถ
# - ๋ณ๊ฒฝ ๋ด์ฉ๋ณด๋ค ๋ณ๊ฒฝ ์ด์ ๋ฅผ ์์ฑ (๋์ค์ ๋ดค์ ๋ ์ฝ๋ ์์ฑ ์ด์ ๋ฅผ ํ์
ํ๊ธฐ ์ํด)
#################
################# (์์ Footer ์์ฑ)
# 3. Footer (๊ผฌ๋ฆฌ๋ง)
# ์ ํ ์ฌํญ์ผ๋ก ์ฝ๋ ์์
๊ณผ ๊ด๋ จ๋ ์ด์ ๋ฒํธ ๋๋ ์ฐธ์กฐ ๋งํฌ ๋ฑ์ ์ถ๊ฐ
# ex) ref #21: related to #23, #34
#################
# 3-1. Footer ์์ฑ ๊ท์น
# - ์ด์ ํธ๋์ปค ID๋ฅผ ์์ฑ
# - ์ฌ๋ฌ ๊ฐ์ ์ด์ ๋ฒํธ๋ฅผ ์ ์ ๋๋ ์ผํ๋ก ๊ตฌ๋ถ
#################
# 3-2. Footer Type
# - fix: ์ด์ ์์ ์ค
# - resolve: ์ด์๋ฅผ ํด๊ฒฐํ์ ๋ ์ฌ์ฉ
# - ref: ์ฐธ๊ณ ํ ์ด์๊ฐ ์์ ๋ ์ฌ์ฉ
#################
# ์ต์ข
๋ฉ์ธ์ง ์์
# [FE] feat #21: ํ์์ ๋ณด ์์ ์ปดํฌ๋ํธ ์ถ๊ฐ
# (๊ณต๋ฐฑ ํ์)
# - ์ด๋ฏธ์ง ์
๋ก๋ ๊ธฐ๋ฅ ์ถ๊ฐ
# - ํ์ ์ ๋ณด ์์ API ์ฐ๋
# (๊ณต๋ฐฑ ํ์)
# ref #21: related to #23, #34
#################
# ์ฐธ๊ณ ์ฌํญ
# - Type, Body, Footer์ ๊ฐ๊ฐ ๊ณต๋ฐฑ ์ค๋ก ํ์นธ์ฉ ๋์ ์์ฑ
# - VS Code์์ ์ปค๋ฐ ์ ๊ธ์๊ฐ ๋ฐ๋ฆฌ๋ ํ์์ด ๋ฐ์ํ๋๋ฐ ๊ฒฐ๊ณผ๋ฌผ์๋ ์ํฅ X
# - ^M์ ์ธ์ฝ๋ฉ๋ฌธ์ ๋ก ๋ฐ์ํ๋ ๊ฒ์ด๋ฏ๋ก ๋ฌด์ํด๋ ๋ฌด๋ฐฉ
#################
# ์ปค๋ฐ ๋ฉ์์ง ํ
ํ๋ฆฟ ์ ์ฉ๋ฐฉ๋ฒ
# 1. local์์ ๋ช
๋ น์ด ์
๋ ฅ
# $ git config --local commit.template .gitmessage.txt
# 2. commit (vim ๊ธฐ์ค)
# - "git add ."๋ฅผ ์
๋ ฅํ๊ณ ์ํฐ๋ฅผ ์ณ์ ๋ณ๊ฒฝ์ฌํญ์ด ์๋ ํ์ผ์ ์คํ
์ด์ง ์์ญ์ ์ถ๊ฐ
# - "git commit"์ ์
๋ ฅํ๊ณ ์ํฐ๋ฅผ ์น๋ฉด ์์ ํ
ํ๋ฆฟ์ด ํ์
# - ํค๋ณด๋์์ "s"๋ฅผ ์
๋ ฅํ์ฌ ๋ชจ๋ ์ปค๋ฐ ๋ฉ์ธ์ง๋ฅผ ์
๋ ฅํ ๋ค "esc"
# - ":wq"๋ฅผ ์
๋ ฅํ๊ณ ์ํฐ๋ฅผ ์น๋ฉด ์ปค๋ฐ ์๋ฃ
#################