Skip to content

컨벤션

jgjgill edited this page Oct 8, 2023 · 10 revisions

커밋메시지

  • 접두사로 커밋 메시지를 붙인다.
  • 커밋 메시지 이후 :와 함께 공백을 두고 작업 내용을 작성한다.

커밋성격: 커밋메시지

예시

feat: textarea 컴포넌트 생성

<< 자주 사용하는 태그 종류 >>

  • Feat : 새로운 기능을 추가하는 경우
  • Fix : 버그를 고친경우
  • Docs : 문서를 수정한 경우
  • Style : 코드 포맷 변경, 세미콜론 누락, 코드 수정이 없는경우
  • Refactor : 코드 리펙토링
  • Test : 테스트 코드. 리펙토링 테스트 코드를 추가했을 때
  • Chore : 빌드 업무 수정, 패키지 매니저 수정
  • Design : CSS 등 사용자가 UI 디자인을 변경했을 때
  • Rename : 파일명(or 폴더명) 을 수정한 경우
  • Remove : 코드(파일) 의 삭제가 있을 때. "Clean", "Eliminate" 를 사용하기도 함

<< 기타 태그 타입들 >>

  • Add : 코드나 테스트, 예제, 문서등의 추가 생성이 있는경우- Improve : 향상이 있는 경우. 호환성, 검증 기능, 접근성 등이 될수 있습니다.
  • Implement : 코드가 추가된 정도보다 더 주목할만한 구현체를 완성시켰을 때
  • Move : 코드의 이동이 있는경우
  • Updated : 계정이나 버전 업데이트가 있을 때 사용. 주로 코드보다는 문서나, 리소스, 라이브러리등에 사용합니다.
  • Comment : 필요한 주석 추가 및 변경

타입컨벤션

  • interface가 아닌 type만 사용한다.
  • 타입을 명시적으로 보여주기 위해 접미사로 Type을 추가한다.

예시

type ImageUploaderPropsType = ...

함수/컴포넌트 컨벤션

화살표 함수로 통일한다.

예시

const 함수명 = () => {
  ...
}
Clone this wiki locally