Skip to content

컨벤션 문서

TaejoonPark edited this page Jan 13, 2022 · 8 revisions

협업 규칙

  1. 특이 사항이 없어도 항상 작업 전에 pull(fetch & merge) 할 것
  2. 항상 작업 브랜치가 main, develop가 아닌 feature인지 확인하고 작업할 것

커밋(commit) 규칙

  • prefix 는 영어(소문자)로 작성
  • 커밋 제목은 영어로 내용은 한글로 작성
  • 커밋 내용은 최대한 자세히 작성
prefix 내용
feat: 새로운 기능을 추가할 시
fix: 기능 수정, 버그 수정 시
refactor: 같은 기능인데 코드만 변경되었을 시
conf: 환경 설정이 변경되었을 시(eslint 규칙 수정, pakage.json 수정 등)
docs: 문서 파일 추가, 수정 시(Readme.md 수정 등)
a11y: 접근성 관련 코드 수정
chore: 스타일 및 기타 수정

Issue 규칙

Feature Request Template

  • 제목 : [컴포넌트 이름] 설명
  • 내용 : 이슈에 대한 간략한 설명, 구현할 리스트

Pull Request 규칙

  • 하루에 한 번 동작 가능한 코드 Pull Request 보내기
  • 제목 : [컴포넌트 이름] 설명
  • 내용 : 완료한 이슈 링크, 완료한 내용과 비고

네이밍 컨벤션

컴포넌트 이름

파스칼 케이스 사용

스타일 관련 클래스 이름

카멜 케이스 사용

함수 이름

헝가리안 케이스 사용