이슈 컨벤션
## 🔨 설명 작업할 내용에 대해 상세하게 설명해주세요. ## 📑 완료 조건 어디까지 개발할 것인지 목표에 대해 설명해주세요.
template에 맞게 issue를 작성해주세요. 기존에 만들어둔 template을 사용하면 됩니다.😀
(작업마다 이슈를 작성하는 방법에 한합니다. 구현할때마다 이슈를 생성하는 방법을 따르지 않는다면 위 방법은 사용하지 않습니다.)
이슈 단위 브랜치
이슈마다 브랜치가 1개 있는 셈입니다.
- branch
#이슈번호/feature/ #이슈번호fix/ #이슈번호/test/ #이슈번호/refactor/ ex. #11/feature/make-home-page(cabab-case)
issue 만들고, 그 issue에 맞는 번호를 확인한 뒤, 이 번호에 따라 branch 생성.
branch 이름은 다음과 같은 규칙으로 작성해주세요.
merge가 완료되어 작업이 끝났다면 반드시 branch를 삭제해주세요. 삭제하지 않는다면 추후에 같은 이름의 브랜치가 생성되었을 때 충돌이 발생할 수 있습니다. 충돌은 본인이 확인해서 해결 부탁드립니다.
fix, refactor 또한 issue 작성 후, issue 제목에 맞게 브랜치 생성해서 작업 부탁드립니다.
git commit message convention
- commit(유의미한 작업 별로 쪼개서 자주 커밋 부탁드립니다)
Feat: commit 내용 바디 (좀 더 상세한 커밋 내용) ex. Feat: make-home-page 컴포넌트 구현 - 컴포넌트 구현 완료
해당 이슈와 관련없는 커밋은 하지 않습니다. 관련없는 커밋이 필요하다면 새로운 이슈를 작성하고 브랜치를 변경주세요. 첫 글자는 대문자로 적어주세요
- feat : 새로운 기능 추가 - fix: 버그 수정 - docs: 문서의 수정 - style: (코드의 수정 없이) 스타일(style)만 변경 - refactor: 기존 기능과 동일하게 동작하지만 코드를 리팩토링. - test: Test 관련한 코드의 추가, 수정 (Storybook 작업 포함) - chore: (코드의 수정 없이) 설정을 변경 및 새로운 라이브러리 혹은 패키지 설치 - modify: 기존 기능의 변경(코드 변경) - rename: 디렉토리 구조 변경. 함수 이름 및 변수 이름 변경. - cleanup: 콘솔 로그 및 주석 삭제, 파일 삭제, 불필요한 함수 삭제, 코드 위치 변경 - merge: pull 과정 중 현재 commit과 자동병합이 일어날때 필수적으로 적어줘야하는 commit에 적어줌
PR convention
# pr 제목은 아래와 같이 작성해주세요. [#이슈 번호] Commit Type: pr 제목 ## 📝 작업 내용 > 이번 PR에서 작업한 내용을 간략히 설명해주세요(이미지 첨부 가능) ### 📷 스크린샷 (선택) ## 💬 리뷰 요구사항(선택) > 리뷰어가 특별히 봐주었으면 하는 부분이 있다면 작성해주세요 > > ex) 메서드 XXX의 이름을 더 잘 짓고 싶은데 혹시 좋은 명칭이 있을까요? # 📍 기타 (선택) > 다른 분들이 참고해야할 사항이 있다면 작성해주세요 close #이슈번호
PR title convention
다음과 같은 형식으로 pr 제목을 작성해주세요.
[#이슈번호] keyword: 구현 내용 간략히 ex) [#11] Feat: make-home-page 컴포넌트 구현
merge 전략
dev 브랜치 없이, squash merge 사용. 커밋을 너무 잘게 쪼갰을 경우, 같은 기능끼리 묶어서 rebase 해주시면 좋을 것 같습니다.