☑️  코드 스타일

모든 파일은 기본적으로 Airbnb JavaScript 스타일 가이드를 따릅니다.

TypeScript, NestJS에서 추가로 사용해야 하는 문법의 경우 추후 상의 후 결정 예정입니다.

☑️ 브랜치 전략 - Github Flow

Main 브랜치

• Main 브랜치는 언제든지 배포가 가능한 안정적인 버전입니다.
• Main 브랜치는 빌드가 가능하며 모든 테스트를 통과해야 합니다.
• Main 브랜치가 Github에서 Default 브랜치가 됩니다.

Topic 브랜치

• Topic 브랜치는 새로운 기능을 개발하는 역할입니다.
• Topic 브랜치는 항상 Main 브랜치에서 만듭니다.
• 버그 수정도 Topic 브랜치를 생성하여 진행합니다.
• Topic 브랜치의 이름은 개발할 기능의 {기능명}/{issue-number}-{feature-name} 으로 생성합니다.
  • ex) feat/1-env-setting (영어 소문자로 작성, 띄어쓰기는 - 를 활용)

Git Commit 메세지

Commit 메세지는 한글로 작성합니다.

Type, Subject, Body를 작성합니다.

• Subject는 Commit에 대한 내용을 간결하게 요약합니다.
• Body는 Commit의 상세 내용을 작성합니다.
• Type은 해당 Commit이 어떤 수정 사항인지 그 종류를 나타냅니다.
  • feat : 새로운 기능 추가
  • fix : 버그 수정
  • docs : 문서 관련
  • style : 스타일 변경 (포매팅 수정, - 들여쓰기 추가, …)
  • refactor : 코드 리팩토링
  • test : 테스트 관련 코드
  • build : 빌드 관련 파일 수정
  • cicd : CI/CD 설정 파일 수정
  • chore : 그 외 자잘한 수정

Github PR/Issue 규칙