깃허브 규칙
- git flow 를 사용하기
- dev Branch에서 작업하지 않기
- git issue 템플릿을 사용하여 진행사항을 기록하기
- PR 시 코드리뷰 하기
- feature branch 이름 규칙 /feat-{branch이름}
깃헙 커밋 규칙
| 작업 타입 |
작업내용 |
| ✨ update |
해당 파일에 새로운 기능이 생김 |
| 🎉 add |
없던 파일을 생성함, 초기 세팅 |
| 🐛 bugfix |
버그 수정 |
| ♻️ refactor |
코드 리팩토링 |
| 🩹 fix |
코드 수정 |
| 🚚 move |
파일 옮김/정리 |
| 🔥 del |
기능/파일을 삭제 |
| 🍻 test |
테스트 코드를 작성 |
| 💄 style |
css |
| 🙈 gitfix |
gitignore 수정 |
| 🔨script |
package.json 변경(npm 설치 등) |
[#이슈번호] 타입: 제목의 형식
ex) [feat]: 로그인 기능 추가
Branch naming 생성 규칙
################
# [타입]: 제목의 형식
# ex) [feat] : 로그인 기능 추가
# 제목과 본문의 분리를 위한 공백란
################
# 본문(구체적인 내용)을 아래에 작성
# 여러 줄의 메시지를 작성할 땐 "-"로 구분
################
# 타입에 대한 설명
# build : 빌드 파일 수정
# delete : 기능 삭제
# design : 사용자 UI 디자인 변경 (CSS 등)
# docs : 문서 수정
# feat : 새로운 기능 추가
# fix : 코드(주석 포함), 버그, 코드 스타일(코드 포매팅, 세미콜론 누락 등) 수정
# gitfix : gitignore 수정, commit 충돌 해결
# init : 최초 파일 생성
# update : 기능 수정 또는 기능 추가
# move : 파일 단순 경로변경경
# refactor : 리팩토링 (Production Code), 잘못된 파일 이름 수정
# remove : 파일을 삭제만 한 경우
# test : 테스트 코드 작성
################
❗예시
[feat]: 로그인 기능 추가
- jwt를 이용한 로그인 기능
- 로그인 유효성 검사
- 로그인 예외 처리
branch 생성시
#1 feat/logout