Skip to content

GItHub 규칙

Minjae Kim edited this page Sep 27, 2023 · 3 revisions

브랜치 이름 규칙

feat/page
feat/page/component

커밋 메세지 규칙

🚨 Fix:		[수정한 파일] - [수정 내용]
✨ Feat:	새로운 기능 추가
🎉 Init:	프로젝트 초기 생성
📝 Chore:	그 외 자잘한 수정에 대한 커밋
🚀 Build:	빌드 관련 파일 수정 / 모듈 설치 또는 삭제에 대한 커밋
💄 Style:	CSS, styled-component 스타일 관련 변경
🔨 Refactor:	코드 리팩토링에 대한 커밋
🍱 Asset:	파일(이미지, 아이콘 등) 추가
🔄 Rename:	파일 혹은 폴더명 수정하거나 옮기는 경우
🗑️ Remove:	파일을 삭제하는 작업만 수행하는 경우

PR 규칙

  • PR의 제목은 Task의 타입과 이모지를 포함하도록 작성(커밋 메시지를 활용)
  • PR 템플릿 사용
  • PR 이후 수정 사항 반영시 커밋 메시지는 아래와 같이 작성 권장
    • 🚨 Fix: PR#[PR 넘버] 수정 사항 #N 반영

Merge Rule

main 브랜치에 병합을 하기 위해서 반드시 2명 이상 리뷰어의 승인이 있어야 합니다. 관여하지 않았던 다른 사람의 코드를 보고 자신이 맡은 부분 외에도 이해할 수 있도록 하기 위함입니다.

Slack Github app 알림 사용

효율적인 의사소통을 위해 Github 알람을 Slack 과 연동하여 PR 알람, merge 알람 등을 받고 처리합니다.