✉️ Commit Messge Rules

서버캔디 들의 Git Commit Message Rules

• 반영사항을 바로 확인할 수 있도록 작은 기능 하나라도 구현되면 커밋을 권장합니다.
• 커밋할 땐 서버슬랙에 자동 노티 됩니다.
• pr 필수, request 걸어주세요!
• 기능 구현이 완벽하지 않을 땐, 각자 브랜치에 커밋을 해주세요.
• 커밋 메시지는 commitlint에서 자동으로 에러 캐치해줘요 🙂

module.exports = {
  extends: ['@commitlint/config-conventional'],
  rules: {
    'type-enum': [
      2,
      'always',
      [
        'feat', // 새로운 기능
        'fix', // 버그 수정
        'hotfix', // 핫픽스
        'docs', // 문서
        'refactor', // 리팩토링
        'test', // 테스트 코드
        'style', // 스타일 변경
        'chore', // 기타 자잘한 작업
      ],
    ],
    'scope-enum': [2, 'always', ['notallowed']],
    'subject-case': [0],
  },
};

📜 커밋 메시지 명령어 모음

- feat    : 기능 (새로운 기능)
- fix     : 버그 (버그 수정)
- hotfix  : 장애 복구 (emergency)
- refactor: 리팩토링
- style   : 스타일 (코드 형식, 세미콜론 추가: 비즈니스 로직에 변경 없음)
- docs    : 문서 (문서 추가, 수정, 삭제)
- test    : 테스트 (테스트 코드 추가, 수정, 삭제: 비즈니스 로직에 변경 없음)
- chore   : 기타 변경사항 (빌드 스크립트 수정 등)

커밋 메세지 형식

• 커밋메세지: 설명 형식으로 커밋 메시지를 작성합니다.
• 커밋 설명은 무조건 영어로 한다고 좋은게 아닙니다.
• 최대한 내용 포함과 자세할수록 좋습니다.
• 하지만 너무 길게는 안됩니다.

좋은 예 >

  feat: search api 추가

나쁜 예 >

  검색 api 추가

좋은 예 >