git commitizen의 사용방법 및 template에 대해서 알아보기

Written by 성기동 on
git commitizen의 사용방법 및 template에 대해서 알아보기

Github를 이용해서 Project를 수행하면서 우리는 수많은 commit을 하게 됩니다. 이때 일정한 스타일의 commit message를 작성하면, 해당 message만 확인을 하여도 전체적인 흐름을 이해할 수 있도록 도와줍니다. 오늘은 일정한 commit message를 작성하기 위해 사용할 수 있는 commitizen이라는 라이브러리와 git의 Template에 대해서 알아보는 시간을 가져보고자 합니다.

1. commitizen

설치방법

Commitizen은 현재 node 10 및 12에 대해서 사용이 가능합니다.
아래의 명령어를 통해서 설치가 가능합니다.

npm install -g commitizen

npm install -g cz-conventional-changelog

echo '{ "path": "cz-conventional-changelog" }' > ~/.czrc

사용방법

아래의 명령어를 통해서 commitzen을 사용할 수 있다.

git cz

/assets/images/github-commitzen-template/1.png

commit 메시지의 prefix를 지정한다.

feat: 새로운 기능 추가
fix: 버그 수정
improvement: 호환성, 테스트 커버리지, 성능, 검증 기능, 접근성 등의 향상
docs: 문서수정
style: 코드 포맷팅, 세미콜론 누락 등
refactor: 기존 코드에 대한 리펙토링을 진행

/assets/images/github-commitzen-template/2.png

커밋에 대한 Title, Description등을 입력한다. 이 과정에서 이슈에 대한 연결도 지정하여 git push를 진행한다.

2 git cz에 이모지(emozi) 추가하기!

  1. ~/.czrc의 path를 cz-emoji-conventional로 변경한다.
  2. npm install -g cz-emoji-conventional cz-emoji 설치
  3. git cz로 이모지가 추가되어있는지 확인한다!

/assets/images/github-commitzen-template/4.png

3. Pull Request Template / Issue Template

Github를 이용하게 될 경우 PR(Pull Request), Issue 등록 등을 통해서 프로젝트를 진행한다.
이 과정에서 어떤 작업에 대한 내용인지, 어떠한 이슈인지를 조금 더 명확하게 알 수 있게 하기위해 구체적인 PR/Issue 등록을 해주는 것이 중요하다.
하지만, 작업하는 사람마다 작성하는 양식이 다르다보니, 이해하기 어려운 경우가 종종 발생할 수 있다.
이러한 과정을 해결하기 위해 프로젝트를 진행할때 Template을 등록해서 사용하는 경우가 많다.
아래는 Template 등록에 대한 과정설명이다.

  1. 프로젝트의 .github폴더에 아래의 파일 생성
  • PULL_REQUEST_TEMPLATE.md
  • ISSUE_TEMPLATE.md
  1. PULL_REQUEST_TEMPLATE.md 에 아래와 같은 기본적인 내용을 작성할 수 있다.
## 🧑‍💻 PR 내용

수정/추가한 내용을 적어주세요.

## 📸 스크린샷

스크린샷을 첨부해주세요.
  1. ISSUE_TEMPLATE.md 에 아래와 같은 기본적인 내용을 작성할 수 있다.
## 🤷 이슈 내용

무슨 이슈인가요?

## ✨ 기대 결과

어떤 결과물을 원하시나요?

## 📸 스크린샷

이슈에 해당하는 부분을 보여주세요.

최종적으로 아래와 같은 사진의 형태가 일관되게 나오는것을 알 수 있다.

/assets/images/github-commitzen-template/3.png

Explore more like this

Github Project Management commitizen
git Large File Storage(LFS)

git Large File Storage(LFS)

Github를 이용해서 우리들은 많은 소스들을 손쉽게 관리할 수 있습니다. 하지만, 때로는 용량이 너무 큰 파일때문에 곤란한 경우가 생기기도 하는데요. git에서는 일반적으로 100MB 이상의 파일에 대해서 PUSH를 할 수가 없습니다. 오늘은...

성기동 성기동 28 Jun 2021
[GitHub] Git 브랜치의 종류 및 사용법 (5가지)

[GitHub] Git 브랜치의 종류 및 사용법 (5가지)

Gitflow Workflow에서 사용하는 Git Branch 종류를 이해한다. Gitflow Workflow에서 사용하는 Git Branch 사용법을 이해한다.

성기동 성기동 30 Jun 2020
Github에 Jekyll로 블로그 만들기

Github에 Jekyll로 블로그 만들기

GitHub에서 새 저장소(repository)를 만듭니다. 이 때 저장소의 이름을 자신의 username 뒤에 .github.io가 붙은 이름으로 짓습니다. 이렇게 해야 yourname.github.io의 도메인으로 접속할 수 있는 블로그가 됩니다.

성기동 성기동 29 Jun 2020