커밋 규칙

커밋 규칙은 회사, 팀, 프로젝트에 따라 다를 수 있습니다.
컴퍼레이에서는 협업 효율의 증대를 위해 몇가지의 커밋 규칙을 따릅니다.
ㅤ
다음의 코드를 기반으로 커밋 규칙에 대해 알아봅니다.
두 입력 파라미터의 합을 받아 반환하는 자바스크립트 함수입니다.
add.js 함수를 추가하여 깃 커밋을 위한 메세지 작성 방법을 알아봅니다.

function add(a, b) {
    return a + b;
}

제목 규칙

깃허브 커밋 메시지 제목은 아래의 형태로 구성됩니다.

<커밋 타입 이모티콘> <커밋 타입>: <커밋 제목>

ㅤ

커밋 타입은 수행한 내역과 매치하여 작성합니다.
컴퍼레이에서는 11개의 커밋 타입을 사용합니다.
또한, 가독성을 위해 커밋 타입과 이모티콘을 매치합니다.

• 📦️ package: 패키지 관련 수정
• ✨ feat: 기능, 함수, 유틸 기능 추가
• 🔥 remove: 기능, 함수, 유틸 삭제
• ♻️ refactory: 경로 변경, 코드 구조 수정
• 🐛 bug: 버그, 오타 수정
• 📝 docs: 문서 파일 추가, 수정, 삭제
• ⚡️ perf: 성능 개선
• 🔨 chore: 주석, 개발 스크립트 추가, 수정
• 🔧 config: 개발환경, 구성파일 설정, 변경
• 🙈 gitignore: .gitignore 파일 수정
• 🔖 release: 버전 업데이트

커밋 타입

커밋 타입은 3가지의 문법적인 규칙이 존재합니다.

• 소문자로만 작성합니다.
• 이모티콘 뒤에 커밋 타입을 작성합니다.
• 콜론(:) 뒤에는 한칸의 공백을 부여합니다.

예제 코드는 함수 기능을 추가한 커밋이므로 feat 커밋 타입을 이용합니다.

<커밋 타입 이모티콘> feat: <커밋 제목>

커밋 타입 이모티콘

feat 커밋 타입은 아티클 이모티콘과 매치됩니다.

✨ feat: <커밋 제목>

커밋 제목

수행한 내역을 간단하게 작성합니다.
커밋 제목은 3가지의 문법적인 규칙이 존재합니다.

• 50글자 이내로 작성합니다.
• 개조식 구문으로 작성합니다.
• 마침표 및 특수기호를 사용하지 않습니다.

덧셈 함수를 추가한 커밋이므로 그대로 작성합니다.

✨ feat: 덧셈 함수 추가

본문 규칙

깃허브 커밋 메시지 본문은 아래의 형태로 구성됩니다.
제목 다음 줄을 개행하고, 본문을 작성하는 형태입니다.

<커밋 본문>

커밋 본문

수행한 내역을 최대한 자세하게 작성합니다.
커밋 제목은 2가지의 문법적인 규칙이 존재합니다.

• 한줄 당 72자 이내로 작성합니다.
• 무엇을 왜 변경하였는지 작성합니다.

추가한 함수의 기능과 이름을 명시합니다.

- 계산기를 구현하기 위해 덧셈 함수 추가
- 두 숫자의 덧셈을 수행하는 'add' 함수 추가
- 두 입력 파라미터의 합을 반환