Skip to content

Project 컨벤션

김승진 edited this page Jan 9, 2023 · 4 revisions

Git 커밋 메시지 규칙

  • feat: 새로운 기능을 추가한 경우 사용합니다.
  • fix: 버그를 수정한 경우 사용합니다.
  • refactor: 코드 refactoring한 경우 사용합니다.
  • style: 코드 형식, 정렬, 주석 등의 변경(동작에 영향을 주는 코드 변경 없음)한 경우 사용합니다.
  • test: 테스트 추가, 테스트 리팩토링(제품 코드 수정 없음, 테스트 코드에 관련된 모든 변경에 해당)한 경우 사용합니다.
  • docs: 문서를 수정(코드 수정 없음)한 경우 사용합니다.
  • perf: 성능 개선
  • !hotfix: 급하게 치명적인 버그 고쳐야 하는 경우
  • remove: 파일을 삭제하는 작업만 수행한 경우
  • chore: 빌드 업무 수정, 패키지 매니저 설정 등 위에 해당되지 않는 모든 변경(제품 코드 수정 없음)일 경우 사용합니다, 위에 명시되지 않은 모든 것

Pull Request 규칙

  • 새로운 기능 추가 시 main을 기반로 [#이슈번호] 추가한 기능의 브랜치명으로 생성 후 작업한다.
  • pr 제목 ex) [#8] front, backend 프로젝트 초기화
  • 현재 개발 진행 중이라면 In Progress 라벨.
  • 코드리뷰가 필요한 경우 Asking for Review 라벨.
  • 리뷰 후 리팩토링이 필요하다면 추가로 refactoring 라벨.
  • 모든 PR은 반드시 지정한 리뷰어에게 코드리뷰를 받아야만 합니다.
  • 리뷰어 중 1명 이상의 Approve 를 받아야 Merge pull request 를 할 수 있다.
  • (TODO) commit 을 할 때마다 Github Action CI가 자동으로 실행되며 단위테스트, 통합테스트에 모두 통과되어야 Merge pull request가 가능합니다.

Branch 규칙

  • 새로운 기능 추가 시 main을 기반로 feat/#이슈번호_기능의 브랜치명으로 생성 후 작업한다.
  • feat/#8_project_package_init
  • (#8 -> 이슈 번호)
  • branch에서 띄어쓰기는 _(under Bar)로 통일한다.

백엔드 code 규칙

google-java-format

iOS code 규칙

swift-style-guide

Android code 규칙

ktlint