Coding Convention

Git & GitHub

release - develop - feature

1. release : 출시 버전 별로 관리하는 브랜치입니다.
2. develop : 가장 기본이 되는 메인 브랜치입니다. 모든 Feature 브랜치는 develop으로 Merge 되어야 합니다.
3. feature : Feature 별로 브랜치를 따서 작업합니다

Branch

feature/#이슈번호_기능(어떤 기능인지에 대한 이름은 camelCase 방식을 따름)

• ex) feature/#1_loginButton

Commit

init: 초기 설정
feature: 새로운 기능 추가
fix: 버그 수정
docs: 문서 수정
refactor: 리팩토링
test: 테스트 코드
chore: 코드 내 설정부분 수정(ex, properties), 사소한 부분 수정

• 커밋은 메서드 단위로 하기!
• 최대한 자세하기 쓰기!
• 프론트엔드에서 개발한 내용인지 백엔드에서 개발한 내용인지 쓰기!
• ex) feat(BE): 회원가입 이메일 정규식 확인 기능 구현

Pull Request Rules

• PR Title
  • Title(기능 정의)
    • ex) Bookmark 예외처리
    • ex) 무언가를 리팩토링
• PR Body
  • Issue 번호 명시
  • What? How? Why?
  • 설명은 최대한 상세히
• 한 번 PR 할 때 최대 1000줄