Skip to content

WaskConvention

new Dean("유진") edited this page Aug 7, 2020 · 6 revisions

목차

  1. 코딩 컨벤션
  2. 커밋 메시지 컨벤션

1. 코딩 컨벤션

  • 기본적으로 캠퍼스 핵데이 Java 코딩 컨벤션를 따른다.
  • 변수명은 약어를 사용하지 않는다.

    ex)
    settingBtn(X) → settingButton(O)
    ll(X) → linearLayout(O)
    tv_card(X) → textview_card(O)


  • resource naming은 아래 참고

2. 커밋 메시지 컨벤션

type: subject

body

footer

1) Commit Type

Type 의미
feat 기능 (새로운 기능)
fix 버그 (버그 수정)
refactor 리팩토링 (네이밍 변경 포함)
style 스타일 (코드 형식, 세미콜론 추가: 비즈니스 로직에 변경 없음)
docs 문서 (문서 추가, 수정, 삭제)
test 테스트 (테스트 코드 추가, 수정, 삭제: 비즈니스 로직에 변경 없음)
chore 기타 변경사항 (빌드 스크립트, 패키지 매니저 수정 등)

cf) View에 대한 수정 -> style

2) Subject

제목은 명령어로 작성한다. 마침표를 붙이지 않는다.

3) Body (선택)

부연 설명이나 커밋의 이유를 작성한다.

4) Footer (선택)

주로 이슈번호를 남긴다.

ex) Issue: #00, Resolves: #00, See Also: #00, etc

5) References

Clone this wiki locally