-
Notifications
You must be signed in to change notification settings - Fork 3
Commit Style Guide
onemoon edited this page Jan 30, 2019
·
2 revisions
기본적인 베이스는 udacityCommitStyleGuide 를 따르고 있습니다.
<Type>
<Body>
<footer>
타입에는 타입과 함께 바뀌는 파일 혹은 핵심 기능을 명시합니다. 아래는 타이틀에 사용할 타입들입니다.
-
Feat: 새로운 기능을 생성할때 사용 -
Add: 기존에 있는 기능에 코드를 추가할 때 사용 -
Refactor: 기존 코드를 다른 방식으로 개선할 때 사용 -
Remove: 필요없는 코드 혹은 사라지는 기능을 제거할 때 사용 -
Test: 테스트 코드의 추가 혹은 변경 등 관련된 항목에 대한 코드 수정 시 사용 -
Doc: Readme , gitignore 등의 문서를 작성할 때 사용
Body 는 각 타입에 대한 설명과 기능들에 대한 설명을 적습니다. 예를 들어 테이블 뷰 추가라는 새로운 기능과 리팩토링을 추가한 경우에는 아래와 같이 적습니다.
Feat & Refactor : Table View
Feat
Table View delegate
Refactor
Table View datasource function
Footer 에는 이슈에 대한 명시 , assignee , project 등 코드 자체가 아닌 코드 이외의 필요한 부분에 대해서 명시합니다.
단, 여러 분야에 대한 언급이 필요한 경우 dash(-) 를 사용해서 구분합니다.
- issue : #25 , #48
- reference : https://google.com
Feat & Refactor : Table View
Feat
Table View delegate
Refactor
Table View datasource function
- issue : #25 , #48
- reference : https://google.com