Home

1. Coding Convention

Naming

클래스 명은 대문자로 시작한다.

메소드나 변수명은 Camel case 사용한다.

Indentaion

Tab만 사용한다.

Annotation type

@command 이름	설명
@param	변수, 함수, 인자 설명
@return	반환 값 설명
@see	참고사항 설명
@TODO	반드시 해결해야 하는 중요 문제
@FIXME	오작동 코드
@deprecated	삭제 예정

2. Commit Message Convention

[Commit Type:#이슈번호] 커밋 내용 설명

카테고리만 영어로 작성, 나머지 한글로 작성

코드가 아닌 문서의 추가, 수정 및 삭제의 경우 별도로 Commit Type을 붙이지 않음

Commit Type

Commit Type	설명
feat	새로운 기능에 대한 추가
fix	잘못된 부분 수정
add	코드에 대한 추가사항
hotfix	문제 해결이 시급한 부분 수정
mod	그 외 자잘한 수정에 대한 커밋
refact	코드 리팩토링
test	테스트 코드 수정

Merge

팀원의 Pull Request에 리뷰를 반드시 작성

모든 팀원이 동의한 경우, 원격 브랜치에 Merge

3. Issue Title

[Commit Type] 이슈 제목, 커밋 타입 라벨, 담당자 이름 라벨, Assignee 추가