Skip to content

GitHub Convention

hyeinKim edited this page Jan 11, 2022 · 4 revisions

1. Issue

작업 시작 전 Issue 생성이 선행되어야 한다. Issue는 뷰 단위로 생성하며 생성 후 표시되는 Issue Number를 참조하여 Branch Name과 Commit Message를 작성한다.

이슈 관련 작업이 끝나면 Issue를 Close한다.

이슈는 아래 양식으로 탑재한다.

## 📝 DESCRIPTION
-  Date :
## ☑️ TODO
- [ ] TODO 1
- [ ] TODO 2

2. Commit

2.1. Commit Rule

[<Prefix>] <Description> (Issue_Number)
  • FIX : 버그, 오류 해결
  • FEAT : 새로운 기능 구현
  • DOCS : README나 WIKI 등의 문서 개정
  • REFACTOR : 내부 로직은 변경 하지 않고 기존의 코드를 개선하는 리팩토링 시
  • CHORE : 그 이외의 잡일/ 버전 코드 수정, 패키지 구조 변경, 파일 이동, 가독성이나 변수명, reformat 등
  • UI : 레이아웃 코드만 추가되거나 수정되었을 시

2.2. Commit Example

  • [FEAT] google login (#11)
Clone this wiki locally