Skip to content

Commit 07380ba

Browse files
authored
Update README.md
깃 커밋 컨벤션 추가
1 parent 7e0be16 commit 07380ba

File tree

1 file changed

+69
-0
lines changed

1 file changed

+69
-0
lines changed

README.md

+69
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,71 @@
11
# DongSan2Mong
22
건국대학교 2023년 1학기 산학협력프로젝트 [진매알밥양많이] 팀의 부동산 플래너 어플 "동산이몽"의 리포지토리입니다.
3+
4+
# DongSan2Mong
5+
건국대학교 2023년 1학기 산학협력프로젝트 [진매알밥양많이] 팀의 부동산 플래너 어플 "동산이몽"의 리포지토리입니다.
6+
7+
# Commit Message Convention
8+
### 1. 기본 구조
9+
> 제목 (Type: Subject)
10+
> (한줄 띄고)
11+
> 본문 (Body)
12+
> (한줄 띄고)
13+
> 꼬리말 (Footer)
14+
15+
### 2. 커밋의 타입 구성
16+
> 태그: 제목
17+
> : 뒤에만 space를 넣는다.
18+
19+
| Tag | Description |
20+
| :---: | :---: | :---: |
21+
| `Feat` | 새로운 기능을 추가 |
22+
| `Fix` | 버그 수정 |
23+
| `Design` | CSS 등 사용자 UI 디자인 변경 |
24+
| `!BREAKING CHANGE` | 커다란 API 변경의 경우 |
25+
| `!HOTFIX` | 급하게 치명적인 버그를 고쳐야하는 경우 |
26+
| `Style` | 코드 포맷 변경, 세미 콜론 누락, 코드 수정이 없는 경우 |
27+
| `Refactor` | 프로덕션 코드 리팩토링 |
28+
| `Comment` | 필요한 주석 추가 및 변경 |
29+
| `Docs` | 문서 수정 |
30+
| `Test` | 테스트 코드, 리펙토링 테스트 코드 추가, Production Code(실제로 사용하는 코드) 변경 없음 |
31+
| `Chore` | 빌드 업무 수정, 패키지 매니저 수정, 패키지 관리자 구성 등 업데이트, Production Code 변경 없음 |
32+
| `Rename` | 파일 혹은 폴더명을 수정하거나 옮기는 작업만인 경우 |
33+
| `Remove` | 파일을 삭제하는 작업만 수행한 경우 |
34+
35+
- 예시
36+
- Feat [#12] Home - 서치바 레이아웃
37+
- Add [#15] 리포트 에셋 추가
38+
39+
### 3. Subject
40+
- 제목은 50글자 이내
41+
- 첫글자는 대문자
42+
- 마침표 및 특수기호 사용X
43+
- 현재시제
44+
- 간결하게
45+
46+
### 4. Body
47+
- 72자 이내
48+
- 최대한 상세히(코드 변경의 이유가 명확할수록 좋음)
49+
- 어떻게보다 무엇을, 왜
50+
51+
### 5. Footer
52+
- 선택사항
53+
- issue tracker ID 명시하고 싶을 떄만
54+
- 유형: #이슈 번호
55+
- 여러 개의 이슈변호는 쉼표(,)로 구분
56+
- 이슈 트래커 유형은 다음 중 하나를 사용
57+
- Fixes: 이슈 수정중(아직 해결되지 않은 경우)
58+
- Resolves: 이슈를 해결했을 때
59+
- Ref: 참고할 이슈가 있을 때
60+
- Related to: 해당 커밋에 관련된 이슈번호(아직 해결되지 않은 경우)
61+
- ex)
62+
- Fixes: #45 Related to: #34, #23
63+
64+
### 6. Example
65+
Feat: 회원 가입 기능 구현
66+
67+
SMS, 이메일 중복확인 API 개발
68+
69+
Resolves: #123
70+
Ref: #456
71+
Related to: #48, #45

0 commit comments

Comments
 (0)