YURentCar‐FE GitHub Repo Convention

이슈 작성 규칙

[<이슈 종류(이모지 없이)>] <알아보기 쉽게 제목 작성>

• label 설정
• assigneess 설정

이슈 종류

• ✨ Feat : 새로운 기능의 개발 (새로운 html, css 생성 포함)
• 🔧 Fix : 코드 수정, 기능 변화가 있는 코드 변경 (html, css 기능 변화가 있는 걸로 취급)
• 📐 Chore : 개발환경 세팅 (React, npm, git 설정 등), 문서 작성, 배포 이슈
• 📣 PRMerge : develop -> main 으로 가는 Pull Request 시 사용
  
  
  
  

풀 리퀘스트 작성 규칙

[<이슈 종류(이모지 없이)>/<이슈번호1>, <이슈번호2>] <제목>

• reviewer 설정
• assigneess 설정
• 이슈 종류 중 PRMerge 는 develop -> main 으로 가는 PR 에만 사용
• 관련 이슈 등록 시 : #이슈번호
  
  

🚀 Background

• 간단한 내용요약이나 개요

🥥 Contents

• 작업한 사항들에 대한 상세 설명
• 필요할 경우 관련 코드 기입

🧪 Testing

• 작업한 사항들에 대한 테스트 사항들 기입
• 테스트에 성공했는지 실패했는지 확실히 체크

📸 Screenshot

• 구현된 기능들 촬영
• 필수 사항 x

⚓ Related Issue

• PR 에 관련된 이슈들 등록
• #이슈번호
• 만약 해당 이슈들을 닫을 수 있다면 -> close #이슈번호

📚 Reference

• PR 작업 중 참고한 자료, 문서들 기입
  
  
  
  

브랜치 관리 규칙

- main : 완성되어 배포가 가능한 브랜치
- develop : 배포전의 개발 브랜치
- feature : 특정 기능 구현을 위한 브랜치 & 구현이 끝난 후에는 PR 을 통해 삭제

브랜치 이름 작성 규칙

<이슈 종류(이모지 없이)>/#<이슈 번호>-소문자-소문자-소문자...

커밋 관리 규칙

커밋 종류

• Merge : 병합 상황에 사용
• PRMerge : Pull Request 시 사용
• Feat : (추가) 기능 구현 (만드는 중에 예전 코드를 건드려도)
• Fix : 추가되는건 없으면서 원래 것만 수정되는 상황 모두
• Chore : 사소한 일 (배포, 개발 환경 세팅 등의 위의 사항들이 아닌 모든 커밋)

커밋 메시지 작성 규칙

<커밋 종류>/#<이슈or풀리 번호>: <뭘 했는지>

주요 변경 내용1
 - 주요 변경 내용1 에 대한 세부 사항 // 필수 아님

주요 변경 내용n
 - 주요 변경 내용n 에 대한 세부 사항

• 만약 한 줄에 72자정도를 넘으면 가독성을 위해 엔터를 쳐서 행을 나눔
• 변경 내용에 대한 세부 사항은 반드시 필요하지 않음
• 무엇을 했는지에 대해 ~했어요. ~하였습니다 보다 추가, 삭제 같은 깔끔한 마무리

PRMerge 커밋 시

이슈 브랜치에서 develop 으로 이동 시

• 제목은 PRMerge/#PR번호: <#이슈번호 -> develop> 와 같이 적고, 내용은 github에서 제공해주는 대로 그대로 작성
• ex)
• 제목 : PRMerge/#3: <#1 -> develop>
• 내용 : [Chore/#1] 이슈 템플릿, 풀 리퀘스트 템플릿 추가

develop 브랜치에서 main 으로 이동 시

• 제목은 PRMerge/#PR번호: <develop -> main> 와 같이 적고, 내용은 github에서 제공해주는 대로 그대로 작성
• ex)
• 제목 : PRMerge/#6: <develop -> main>
• 내용 : [PRMerge/#1, #2] 이슈 & 풀 리퀘스트 템플릿 적용 및 이슈 종류 이모지 변경 적용