Convention - E-TF/LaLa GitHub Wiki

프로젝트의 전체적인 코딩 컨벤션의 규칙을 따른다.

• Java Convention

  • indentaion-tab: 4-spaces-tab
  • Line-wrapping: line-length-120

  Naver Hackday Convention

• Main: 서비스 출시할 브랜치
• develop: 다음 버전을 개발하는 브랜치, 기능 개발 구현이 완료될 경우 main 브랜치에 merge 한다.
• feature: 기능 개발 브랜치
• release: 배포를 준비할 때 사용될 브랜치
• hotfit: 배포 후 발생한 버그를 수정하는 브랜치

참고 및 출처
우린 Git-flow를 사용하고 있어요

1. Commit Message Structure

   • 커밋 메시지는 제목, 본문, 꼬리말 세 가지 파트로 나뉘고, 각 파트는 빈 줄로 구분한다.

     [제목]type(옵션): [#issueNumber - ]Subject
     (한 줄을 띄워 분리한다.)
     [본문]body(옵션)
     (한 줄을 띄워 분리한다.)
     [꼬리말]footer(옵션)
     

2. Commit Type

   • 커밋의 타입 구성

     태그: 제목
     :(space)제목으로 :뒤에만 space를 사용한다.
     

     Commit Type

     
     

     Tag Name	설명
     Feat	새로운 기능을 추가할 경우
     Fix	버그를 수정한 경우
     Design	CSS 등 사용자 UI 디자인 변경
     !BREAKING CHANGE	커다란 API 변경의 경우
     !HOTFIX	급하게 치명적인 버그를 고쳐야 하는 경우
     Style	코드 포맷 변경, 세미 콜론 누락, 코드 수정이 없는 경우
     Refactor	프로덕션 코드 리팩토링
     Comment	필요한 주석 추가 및 변경
     Docs	문서를 수정한 경우
     build	빌드 파일을 수정한 경우
     Test	테스트 추가, 테스트 리팩토링(프로덕션 코드 변경 X)
     Perf	성능 개선
     CI	CI 설정 파일을 수정한 경우
     Chore	빌드 테스트 업데이트, 패키지 매니저를 설정하는 경우(프로덕션 코드 변경 X)
     Rename	파일 혹은 폴더 명을 수정하거나 옮기는 작업인 경우
     Remove	파일을 삭제하는 작업만 수행한 경우

• 제목과 본문은 한 줄로 띄워서 분리한다.
• 제목은 영문 기준 50자 이내, 한글은 30자 이내로 한다.
• 제목 첫 글자는 대문자로 시작한다.
• 제목 끝 부분에 .(dot) 사용을 금지한다.
• 제목은 명령조로 작성한다.
• Github - 제목(이나 본문)에 이슈 번호를 붙인다.
• 본문은 영문 기준 72자마다 줄 바꾼다.
• 본문은 어떻게 보다 무엇을, 왜에 맞춰 작성한다.

Commit Message Emojis

Emojis

Emoji	Raw Emoji Code	Description
🎨	:art:	코드의 형식/구조를 개선할 때
📰	:newspaper:	새 파일을 만들 때
📝	:pencil:	사소한 코드 또는 언어를 변경할 때
🐎	:racehorse:	성능을 향상 시킬 때
📚	:books:	문서를 쓸 때
🐛	:bug:	버그 reporting 할 때, @FIXME 태그 삽입
🚑	:ambulance:	bug를 고칠 때
🐧	:penguin:	Linux에서 무언가를 고칠 때
🍎	:apple:	Mac OS에서 무언가를 고칠 때
🏁	:checkered_flag:	Windows에서 무언가를 고칠 때
🔥	:fire:	코드 제거 또는 파일 제거할 때 @CHANGED 태그 삽입
🚜	:tractor:	파일 구조를 변경할 때, 🎨와 함께 사용
🔨	:hammer:	코드를 리팩토링 할 때
☔	:umbrella:	테스트를 추가할 때
🔬	:microscope:	코드 범위를 추가할 때
💚	:green_heart:	CI 빌드를 수정할 때
🔒	:lock:	보안을 다룰 때
⬆️	:arrow_up:	의존성을 업그레이드 할 때
⬇️	:arrow_down:	의존성을 다운그레이드 할 때
⏩	:fast_forward:	이전 버전/브랜치에서 기능을 포워드 포팅할 때
⏪	:rewind:	최신 버전/브랜치에서 기능을 백 포트할 때
👕	:shirt:	linter/strict/deprecation 경고를 제거할 때
💄	:lipstick:	UI/Style를 개선할 때
♿	:wheelchair:	접근성을 개선할 때
🌐	:globe_with_meridians:	세계화/국제화/i18n/g11n을 다룰 때
🚧	:construction:	WIP(진행중인 작업)에 커밋, @REVIEW 태그 삽입
💎	:gem:	New Release
🥚	:egg:	New Release with Python egg (Python 패키지 형식)
🎡	:ferris_wheel:	New Release with Python wheel package (Python 휠 패키지 형식)
🔖	:bookmark:	Tags 버전
🎉	:tada:	초기 커밋
🔈	:speaker:	로깅을 추가할 때
🔇	:mute:	로깅을 줄일 때
✨	:sparkles:	새로운 기능을 소개할 때
⚡	:zap:	Backward-InCompatible 기능을 소개할 때, @CHANGED 태그 삽입
💡	:bulb:	새로운 Idea, @IDEA 태그 삽입
❄️	:snowflake:	일반적으로 🐧, 🎀 또는 🚀과 함께 구성 변경
🎀	:ribbon:	고객이 애플리케이션 사용자 정의를 요청했을 때, @HACK 태그 삽입
🚀	:rocket:	배포(구축)/DevOps와 관련된 모든 항목
🐘	:elephant:	PostgreSQL 데이터베이스 관련 (마이그레이션, 스크립트, 확장, ...)
🐬	:dolphin:	MySQL 데이터베이스 관련 (마이그레이션, 스크립트, 확장, ...)
🍃	:leaves:	MongoDB 데이터베이스 관련 (마이그레이션, 스크립트, 확장, ...)
🏦	:bank:	일반 Database 데이터베이스 관련 (마이그레이션, 스크립트, 확장, ...)
🐳	:whale:	Docker 구성
🤝	:handshake:	파일을 병합할 때
🍒	:cherries:	하나 이상의 커밋에서 커밋이 발생하는 경우 Cherry-Pick

참고 및 출처
좋은 git 커밋 메시지를 작성하기 위한 8가지 약속
[협업] 협업을 위한 git 커밋컨벤션 설정하기