Skip to content

Project Convention

Jammini edited this page Jul 31, 2023 · 2 revisions

Git Branch Strategy

Github-Flow 전략을 사용한다.

image

Commit Message Convention

커밋 메세지는 다음과 같은 형식으로 작성한다.

[TYPE] COMMIT_MESSAGE

  • [TYPE]
    • feature : 새로운 기능 추가
    • fix : 버그 수정
    • docs : 문서 업데이트
    • refactor : 코드의 리팩토링
    • test : 테스트코드 업데이트
    • env : 환경 구축
  • COMMIT_MESSAGE
    • TYPE을 기입했다면, 그 이후에는 COMMIT_MESSAGE 부분에 해당 커밋에 대한 내용을 간략하게 기술

Culture

객체지향 체조 5번 줄여쓰지 않는다.

객체지향 체조 9번 getter/setter/property를 쓰지 않는다.

축약어를 일반 명사와 같은 취급한다.

  • 특별취급 하지말고 일반 단어 사용하듯 사용

    • String userID -> String userId
    • String IP -> String ip
  • 참고

Coding convention