Commit convention for me.md

📝 Commit Messages

Semantic Commit Messages 및 conventionalcommits.org를 참고하여 개인적으로 사용할 커밋 컨밴션을 정리했습니다.
시멘틱 커밋 메세지 규칙을 온전히 따르지 않고 일부 변형하여 사용하므로 참고하세요.

Format: <type>(<scope>): <short summary>

<scope>는 선택적입니다.

✏️ 작성 방법

feat: 고양이가 귀여워지는 효과 추가
^--^  ^------------^
|     |
|     +-> 짧고 간단한 요약 (현재 시제)
|
+-------> 타입: chore, docs, feat, fix, refactor, style, test 등

자세한 예시:

• feat: (새로운/메인 기능 추가/변경)
• perf: (성능을 위한 변경사항)
• fix: (버그/이슈 해결)
  • fix(#1): 고양이가 나타나지 않던 문제 해결 처럼 작성
  • *주의: fix를 포함한 커밋 메세지는 이슈를 닫음, #1은 이슈 번호.
• ci: (CI 설정)
• cd: (CD 설정)
• ci/cd: (CI/CD 동시에 변경되는 경우) - CI/CD 따로 사용 추천 (GitHub Refined가 지원하지 않음)
• docs: (문서에 대한 변경사항)
  • docs(README): 개발 가이드 추가
• style: (포멧팅, 세미콜론 추가/삭제 등; 실제로 작동하는 코드에 영향 없음)
  • 규칙상 UI 디자인은 feature로 분류하나, 리포지토리에 따라 아닌 경우도 있음
• refactor: (코드 리팩터링, 변수/함수의 이름 변경 등)
• test: (테스트 코드 추가)
• chore: (코드 동작에 논리적 변화가 없는 기타 작업, 종속성 마이너< 버전 업데이트, .gitignore || .editorconfig 등)

🚨 Attention!

주요 변경사항, 단일 대형 커밋, 가능하면 사용하지 않는게 좋음

feat!: 회원가입 인증 메일에 고양이 사진을 포함하지 않습니다.

Scope와 함께 사용시 GitHub Refined가 하이라이팅 하지 않음

---

🔥 참고자료:

• https://www.conventionalcommits.org/
• https://seesparkbox.com/foundry/semantic_commit_messages
• http://karma-runner.github.io/1.0/dev/git-commit-msg.html
• GitHub Refined