Skip to content

commit style

Jump to bottom
Juhee Kim edited this page Jan 22, 2019 · 4 revisions

One Day Commit Guide

Branch 전략

master : 프로젝트 릴리즈 develop : 개발 feature : 각 기능 별 브랜치 생성

branch 이름은 스네이크 표기법을 사용합니다.

예) feature/memo_list feature/add_memo

각 기능 개발이 끝나면 develop branch 으로 merge 합니다.

feature -> develop merge시 커밋은 하나로 작성합니다.

feature 단의 commit 은 개발자의 취향에 따릅니다. 단, 반드시 build가 되는지 확인하고 commit 해야 합니다.

develop, master commit 메시지는 다음과 같이 작성합니다.

Commit message

<Title> 

<Body>

<Issue>

Title

타이틀은 한 문장으로 작성합니다.

연관된 기능을 하나의 커밋으로 작성합니다. 두 개의 기능을 동시에 변경했다면 두 개의 커밋이 만들어져야 합니다.

  • [생성] : 새로운 기능을 생성할때 사용
  • [추가] : 기존에 있는 기능에 코드를 추가할 때 사용
  • [수정] : 기존 기능을 수정해야할 때 사용
  • [리팩토링] : 기존 코드를 다른 방식으로 개선할 때 사용
  • [테스트] : 테스트 코드의 추가 혹은 변경 등 관련된 항목에 대한 코드 수정 시 사용

Body

Body 는 각 타입에 대한 설명과 기능들에 대한 설명을 적습니다. 예를 들어 일기 상세라는 새로운 기능을 추가한 경우에는 아래와 같이 적습니다.

[생성] : 일기 상세

- DiaryDetailViewController 추가
- StoryBoard에 DiaryDetailViewController 추가

Issue

Issue는 필요할 경우에만 작성합니다. 이슈에 대한 명시, 코드 이외의 필요한 부분에 대해서 명시합니다. Body와 Issue를 구분하기 위해서 * 를 사용해서 구분합니다.

* issue : #25 , #48
* reference : https://google.com

Example

[생성] : 일기 상세

- DiaryDetailViewController 추가
- StoryBoard에 DiaryDetailViewController 추가

* issue : #25 , #48
* reference : https://google.com

udacity commit style guide

Clone this wiki locally