Skip to content
Choi Dong Kuen edited this page Jan 13, 2023 · 3 revisions

안녕하세요 프로젝트를 진행하면서 저희끼리 지켜야할 규칙을 간단하게 요약하고자 합니다 🧑🏼‍💻

1. 커밋 메세지 컨벤션(Commit Message Convention)

[# Issue Number ] Type : Subject

[한 줄 공백]

Body : [본문]

[한 줄 공백]

Footer : [꼬리말]

📕 Type 정리

Type 이름 설명
Feat 새로운 기능
Fix 버그 수정
Docs README, Wiki 문서 수정
Style 코드 변경 없이 스타일 변경
Refactor 리팩토링
Chore 동작에 영향이 없는 코드 변경 없는 변경 사항(ex 주석 추가)
Update 변경 사항
Test test 코드의 작성 및 수정이 이루어졌을 때

📕 요약

다른 팀원의 코드 이해를 돕기 위해 최대한 커밋 컨벤션을 지키되 본문과 꼬리말은 선택사항입니다 👨‍💻

2. PR 규칙

  • PR 은 3명의 approve 가 있어야 Merge 가능합니다.
  • PR 을 올릴 때 여러가지 테스트 사항이 있다면 체크 박스를 이용하여 팀원들에게 알립니다.
  • PR 최대한 자주 꼼꼼히 보고 궁금한 사항 있으면 Comment 남기기!

3. Git Hub 협업 단계 요약

  1. 내가 진행할 작업에 대해 정리해보기
  2. 작업의 단위를 잘게 쪼개보기
  3. 잘게 쪼갠 기능을 이슈로 등록하기
  4. DEVELOP 브랜치 기준으로 feature 브랜치 생성하기
  5. feature 브랜치에서 개발 진행
  6. PR 등록
  7. 코드 리뷰를 받고 수정할게 있다면 수정해서 다시 push
  8. Merge 완료시 개발 진행했던 feature 브랜치 삭제
Clone this wiki locally