Skip to content

Latest commit

 

History

History
72 lines (58 loc) · 2.73 KB

RULE.md

File metadata and controls

72 lines (58 loc) · 2.73 KB

Pull Reqeust 규칙

브랜치 규칙

  1. 조장/테크리더가 Weekly 브랜치 생성

    • 4주차부터는 이전 주차 Master 브랜치를 클론
  2. 각자 배정받은 기능 목표한 날짜까지 구현

    • 구현한 기능은 Weekly 브랜치에 commit
  3. 기능별 브랜치 생성

    • 포크 없이 프로젝트에 브랜치 생성시 브랜치 이름은 `feature/#이슈넘버-기능으로 생성
    • ex) docs/#1-README.md
  4. 프로젝트 리뷰 미팅을 통해 오류 해결 및 보고서 작성

    • 조장/테크리더는 이후 Weekly에서 Develop으로 conflict 해결 및 merge

커밋 규칙

  • 커밋 메시지는 크게 제목, 본문의 두 파트로 구분한다.
  • 각 파트는 빈 줄로 구별한다.
type(옵션): [#issueNumber] subject     //  -> 제목

body(옵션)     //  -> 본문

예시: docs:[#1]-ADD

RULE.md 작성

type 종류

feat 새로운 기능 추가 기능
fix 버그 수정 기능
design CSS/UI 변경 기능
style 코드 포맷팅 (코드에 논리적 변경사항이 없는 경우) 개선
refactor 코드 리팩토링. 새로운 기능이나 버그 수정 없이 현재 구현을 개선 개선
comment 필요한 주석 추가 및 변경 개선
establish 초기 환경설정 / 설정 파일 추가 기타
docs 문서 수정 기타
test 테스트 코드 추가 기타
chore 빌드 업무, 패키지 매니저 수정 기타
remove / rename 파일 삭제 / 파일명 변경 기타
!HOTFIX 긴급한 버그 수정 (핫픽스) 기타

제목 작성법


제목은 코드 변경 사항에 대한 짧은 요약으로, 다음과 같은 규칙을 가짐 동사 원형으로 시작한다. 커밋 메시지 템플릿 추가 (X) 추가 - 커밋 메시지 템플릿 (O) 커밋 제목에 사용되는 영단어 예시

Fix 올바르지 않은 동작을 수정
Add 코드, 예제, 문서 추가
Remove 코드 삭제
Update 원래도 정상적으로 동작하던 것을 수정, 추가, 보완
Simplify 복잡한 코드를 단순화 (약한 Refactor)
Refactor 코드의 전면 수정
Improve 호환성, 테스트 커버리지, 성능의 향상
Implement 구현체 완성
Correct 문법 오류나 타입의 수정

본문 작성법

가독성을 위해 한 줄당 75자 이내로 제한하지만, 전체 내용은 양에 상관없이 최대한 상세하게 작성.

코드 컨벤션

구글 자바 스타일 가이드에 따라 작성. https://google.github.io/styleguide/javaguide.html