문단

브랜치 당 하나의 문단을 할당한다.

제목 크기

작업의 상하관계를 직관적으로 파악할 수 있도록, 하위 작업(브랜치)은 하위 문단으로 작성한다.

하위 브랜치의 정의: 작업 완료 후 상위 브랜치로 merge하게 되는 브랜치

e.g., (하위)feature → (상위)develop로 merge하게 되므로,

• develop
  • feature2
  • feature1

위와 같은 문단 구조로 작성한다.

문단 순서

브랜치 생성 시간 기준 내림차순으로 정렬한다. 즉, 최근 생성된 브랜치의 문단이 위로 오게끔 정렬한다.

• develop
  • 제일 최근에 생성된 브랜치
  • 그 다음에 생성된 브랜치
  • 처음 생성된 브랜치

작업 완료 후 병합된 브랜치

develop에 병합된 브랜치의 문단 제목은 취소선 처리한다.

문단 형식

메모

예시 메모

예시 두 번째 메모

인용 블록을 이용해 브랜치에 관련해 참고할 내용을 메모한다.

커밋 로그 & 노트

1. [이름] - [커밋 해시 | 커밋 링크] | [파일명]
   • [커밋 요약 및 노트]

마크다운 팁: 번호는 모든 항목에 대해 1로 작성하면 자동으로 알맞게 변환된다.

진행 중인 작업

• [이름] - [진행 중인 작업]

진행 중인 작업이 하나라도 있을 경우, 수평선을 그은 후 그 아래에 작성한다.

포맷

파일 이름, 클래스 이름, 메서드 이름은 코드 블록으로 표시한다.

e.g., Core.java, Screen, drawCenteredRegularString