kangwooc / conventional_commit_test

Conventional Commit

Step

1. commitizen을 설치해준다.

• commitizen은 커밋의 포맷을 설정해주는데에 도움을 주는 모듈이다.

yarn add -D commitizen

2. commitizen을 프로젝트에 세팅해준다.

## yarn을 사용시에 
npx commitizen init cz-conventional-changelog --yarn --dev --exact 
## 혹은 1번에서 전역 설치를 진행 후에 
commitizen init cz-conventional-changelog --yarn --dev --exact

3. husky, commitlint, lint-staged를 설치해준다.

yarn add -D husky @commitlint/config-conventional @commitlint/cli

4. commitlint.config.js 파일에 @commitlint/config-conventional 관련 설정을 추가한다.

echo "module.exports = {extends: ['@commitlint/config-conventional']}" > commitlint.config.js

5. 프로젝트에 husky 설치

• husky란?
  • nodejs 환경에서 git hook을 조금 더 원활하게 사용이 가능하게끔 하는 라이브러리

npx husky install

6. prepare-commit-msg에 commitizen 설정을 해준다

• 커밋 메시지를 작성시에 포맷에 맞게 작성이 되게끔 도움을 준다.

npx husky add .husky/prepare-commit-msg 'exec < /dev/tty && git cz --hook || true'

7. commit-msg에 commitlint 세팅을 해준다

npx husky add .husky/commit-msg 'yarn commitlint --edit $1'

실행방법

1. git add <file-path>로 변경사항이 있는 파일들을 추가를 한다
2. git commit으로 커밋 메시지를 작성한다

a. 커밋 타입을 생성한다 b.