Skip to content

프로젝트 컨벤션

Jump to bottom
Seongjin Yoo edited this page Sep 5, 2020 · 9 revisions

프로젝트 컨벤션(Convention)

  • Pull request를 통하여 merge

  • 코드리뷰를 통과해야만 병합

  • wiki에 프로젝트 소개와 기술적 문제 해결 내용을 정리

  • 지속적인 성능 개선 및 코드 리팩토링을 지향

  • 코드 컨벤션

  • 깃 커밋 메시지 스타일 가이드

    자신만의 커밋 메시지 작성 원칙을 정하고 일관성있게 커밋. 많은 작성 가이드 중 유다시티의 커밋 메시지 작성 가이드를 사용. 한글화 하여 커밋 할 예정.

    Type: 제목(Title)

본문(Body)

꼬리말(Footer)

    • 커밋 타입 - Commit Type

      • feat: 새로운 기능을 추가
      • fix: 버그 수정
      • docs: 문서 수정
      • style: 코드 포맷 변경, 세미 콜론 누락, 코드 수정 없음
      • refactor: 코드 리팩터링
      • test: 테스트 코드, 테스트 리펙토링
      • chore: 빌드 업무 업데이트, 패키지 매니저 설정

    • 제목 - Title

      • 제목은 50자를 넘기지 않고, 첫글자는 대문자, 마침표 금지
      • 과거시제가 아닌 명령어로 동사를 먼저 작성
        • "Fixed" --> "Fix"
        • "Modified" --> "Modify"

    • 본문 (선택사항) - Body

      • 본문은 커밋의 상세 내용을 작성
      • 제목과 본문 사이에 한 줄 띄움
      • 본문은 한 줄에 72자 이내로 작성
      • 한 줄을 띄워 문단으로 나누거나 ·(bullet)을 사용해 내용을 구분

    • 꼬리말 (선택사항) - Footer 꼬리말에는 issue tracker id를 추가

      Resolves: #123
See also: #456, #789

    • 커밋 수정 및 삭제

    • 커밋 메시지 스타일 가이드 참고 문헌

  • 브랜치 관리 전략(Git flow)

    image

    image

    • master : 베포 단계에 출시될 수 있는 브랜치

    • develop : 개발이 끝난 버전을 개발하는 브랜치

    • feature : 기능을 개발하는 브랜치

    • release : 베포 버전을 준비하는 브랜치

    • hotfix : 베포 버전에서 발생한 버그를 수정 하는 브랜치

    • issue/* : issue를 나누어서 개발에 적용하는 브랜치

    • 브랜치 참고 문헌

Clone this wiki locally