.gif&blockId=11b00c82-b138-8050-a58b-dcbceda2ef8f)
Commit 기본 구조
<type><is breakchange(!)>: <subject> // 제목
<BLANK LINE> // 구분줄\n
<body> // 내용
Plain Text
복사
제목
<type><is breakchange(!)>: <subject> // 제목
Plain Text
복사
제목 타입: <type>
•
feat: 기능 (feature)
•
fix: 버그 수정
•
docs: 문서 작업 (documentation)
•
style: 포맷팅, 세미콜론 누락 등.
•
refactor: 리팩터링
•
test: 테스트
•
chore: 관리(maintain), 핵심 내용은 아닌 잡일 등
브레이크 체인지 여부: <is breakchange>
기존 개발하는 방식에 비해 많이 변경된 경우를 알리기 위한 표시.
또한, 브레이크 체인지가 존재하는 경우 변경내용에 대한 설명을 body에 작성
•
type뒤에 ‘!’ 추가
•
예시
◦
feat!: 랭킹 점수 계산 공식 변경
feat!: 랭킹 점수 계산 공식 변경
원래 해당 계산식을 사용했었지만
이런 공식으로 코드가 수정되었습니다.
Plain Text
복사
◦
feat: 로그인 기능 구현
제목 내용: <subject>
•
명령조로 작성
•
현재 시제 사용
•
끝에 . 없이 작성
바디: <body>
•
커밋에 대한 동기와 이전 코드와의 대조를 설명
•
현재 시제 사용
•
기본은 선택 사항
•
브레이크 포인트가 존재하는 경우, 반드시 변경 사항의 설명을 body에 명시할 것
예제
feat: 경매품 업로드 기능 구현
Plain Text
복사
feat!: 랭킹 점수 계산식 변경
기존 계산식은 기여 `횟수 * 영상 시간(분)`이었지만, 기획 변경으로 인해 `횟수 * 영상 시간(초)`로 변경되었습니다.
이슈 사항 : https://github.com/gyeongnam-gyeongmae/server/issues/1
Plain Text
복사
이슈(Issue)
•
담당자(Assignees)를 명시 할 것
•
Task list 기능을 적극 활용할 것
•
기능에 관련된 Issue라면 Github Project와 PR(PullRequest)과 연동하여 진행상황을 공유할 것
Pull Request
•
제목은 '[#기능 번호] 변경 사항' 구조로 작성할 것
•
Issue와 연동할 것
•
예시
◦
[#2] 로그인 기능
◦
[#11] 게시글 업로드 기능 구현
Git Wiki
•
소개 : 서비스에 대한 소개
•
기능 : 서비스에 존재하는 기능
•
사용자 매뉴얼 : 사용자가 서비스를 이용할 때 참고할 매뉴얼
•
개발자 매뉴얼 : 개발자가 프로젝트에 참여할 때 참고할 매뉴얼
•
프로젝트에 참여하기 : 프로젝트에 참여하는 방법
•
Contributor : 현재의 contributor
