< TYPE 키워드 ( 커밋 유형 지정 ) >
| FEAT | 새로운 기능 추가 |
| FIX | 버그 수정 |
| REFACTOR | 코드 리팩토링 ( 기능 추가(feat), 버그수정(fix), 성능 개선(perf)을 제외한 코드 수정 ) |
| TEST | 테스트 코드 수정 |
| COMMENT | 필요한 주석 추가 및 변경 |
| BUILD | 빌드 관련 파일 수정 |
| CHORE | 그 외 자잘한 수정 ( 기타 변경, 빌드 업무, 패키지 매니저, .gitignore 수정, .... ) |
| CI | CI관련 설정 수정 |
| DOCS | 문서 추가, 수정, 삭제 |
| STYLE | 스타일 관련 기능 ( 코드 스타일, 세미콜론 누락, 코드 자체의 변경이 없는 경우 ) |
| DESIGN | CSS 등 사용자 UI 디자인 변경 |
| RENAME | 파일 혹은 폴더명 수정 or 옮기는 작업만 한 경우 |
| REMOVE | 파일 삭제 |
| HOTFIX | 급하게 치명적인 버그 고친 경우 |
| PERF | 성능 개선 |
| REVERT | 이전 커밋으로 회귀할 때 |
관련 이슈 (선택 사항)
| 해결 | CLOSES, FIXES, RESOLVES ... |
| 참고 | REF, RELATED TO, SEE ALSO ... |
<type> (<scope>): <subject> -- 헤더 => 제목(간단 요약)
<body> -- 본문 => 내용
<footer> -- 바닥 글 => 주요 변경 사항, 이슈 해결 사항
1. subject 제목
<type> : 변경 사항의 특징에 따라
<scope> : 변경이 된 위치를 적는다. ( 변경된 클래스, 메소드의 이름 등 )
<subject> : 변경 내용을 간단하게 한줄로 요약해서 적는다
- 첫 글자를 소문자
- 마지막에 . 을 쓰지 않는다
- 명령형으로 쓰고, 현재형으로
- 제목은 50자 이하
2. body 본문
- 선택 사항이기에 모든 commit에 본문 내용을 작성할 필요 없다 -> 간단한 내용이면 제목만 적어도 된다
- 영문 기준으로 한 줄에 72자 이하
- 어떻게(How)보다 무엇을, 왜(What, Why)에 맞춰 작성
- 설명뿐만 아니라, commit의 이유를 작성할 때에도 쓴다
3. footer 꼬리말
- 선택 사항이므로 모든 commit에 꼬리말을 작성할 필요 없다
- 주로 Closes(종료), Fixes(수정), Resolves(해결), Ref(참고), Related to(관련) 키워드 사용
- Issue tracker ID를 작성할 때 사용한다
- 해결: 이슈 해결 시 사용
- 관련: 해당 commit에 관련된 이슈 번호
- 참고: 참고할 이슈가 있는 경우 사용
ex )
Feat: 신규 RFID 인식 기능 추가(#123)
신규 RFID 기능 인식 기능 추가
- RFIDReader.java: 사용자 요건 사항으로 인한 RFID 인식 기능 추가
해결: #123git commit -m "fix: Safari에서 모달을 띄웠을 때 스크롤 이슈 수정
모바일 사파리에서 Carousel 모달을 띄웠을 때,
모달 밖의 상하 스크롤이 움직이는 이슈 수정.
resolves: #1137✨ feat(Authentication): Add user authentication feature
* Implement user authentication functionality.
* Enhance security by validating user credentials.
* Connect authentication module with user database.
Resolves: #567✨ feat(인증): 사용자 인증 기능 추가
* 사용자 인증 기능 구현.
* 사용자 자격 증명을 유효성 검사하여 보안 강화.
* 인증 모듈을 사용자 데이터베이스와 연결.
Resolves: #567hotfix / FEAT : add link for favicon in meta.jsp. change og:image content from static file to source urlFEAT & REFACTOR : add btn_yesterday. centralize validation of input.onChange on tran(Add)/addfix(Button): add displayName for Button and ButtonGroup to fix balloon issuechore(plugin): update dependency
- update plugin A to the latest
- update plugin B to 1.2.3Feat: 관심지역 알림 ON/OFF 기능 추가(#123)
시군구의 알림을 각각 ON/OFF 할 수 있도록 기능을 추가함
- opnion0055: 구분 코드
해결: close #123feat: 추가 login 메서드
로그인 API 개발
Resolves: #123fix: Prevent racing of requests
Introduce a request id and a reference to latest request. Dismiss
incoming responses other than from latest request.
Resolevs: #123feat: "로그인 기능 구현"
로그인 시 JWT 발급
Resolves: #111
Ref: #122
related to: #30, #50
Git 커밋 메시지 작성법 - 에디터 활용
git commit (기본 설정된 에디터로 커밋 메시지 작성할 수 있는 화면이 열린다)
편집 모드 종료 :
- [편집모드종료] esc키
- [저장하고 종료] :wq 입력 후 enter키
https://richone.tistory.com/27
[Git] 깃 커밋 메시지 작성법(git commit message) - 2 (에디터 활용)
깃 커밋 메시지를 상세하게 작성하려 할 경우 터미널에서 'git commit -m'을 사용하여 작성하는거는 여간 번거로운 일이 아닐 수가 없다 에디터를 활용하여 깃 커밋 메시지 작성하는 방법을 알아보
richone.tistory.com
https://m.blog.naver.com/motive0604/222665835889
[Git] 깃 커밋 메시지 작성법(git commit message)
개발자는 작명소와 같이 이름짓는 일이 많다. 1. 이름을 짓는다는 것 네이밍의 어려움은 프로그래밍을 하다...
blog.naver.com
Git Commit Convention, 깃 커밋 컨벤션
1. 커밋 컨벤션이란? 형상관리 툴인 Git을 사용하면서 Commit을 할 때 Commit Message를 작성하는 규칙이다. 자신 혼자 개발한다면 Commit Message를 아무렇게나 작성해도 자신은 이해할 수도 있겠지만 시간
hyunjun.kr
Gitmoji site 🎨 🐛 📝
gitmoji
:truck: Move or rename resources (e.g.: files, paths, routes).
gitmoji.dev
refer to
https://velog.io/@chojs28/Git-%EC%BB%A4%EB%B0%8B-%EB%A9%94%EC%8B%9C%EC%A7%80-%EA%B7%9C%EC%B9%99
https://jane-aeiou.tistory.com/93
https://velog.io/@chojs28/Git-%EC%BB%A4%EB%B0%8B-%EB%A9%94%EC%8B%9C%EC%A7%80-%EA%B7%9C%EC%B9%99
https://velog.io/@changonna/Git-Commit-Message-%EC%9E%91%EC%84%B1%EB%B2%95
https://green-bin.tistory.com/14
'IT > IT' 카테고리의 다른 글
| 윈도우11 MS 로그인 없이 로컬 계정으로 로그인 (0) | 2024.11.27 |
|---|---|
| PC 세팅 (0) | 2024.11.18 |
| 가운뎃 점 (·) 단축키 (0) | 2024.10.19 |
| Cookie & Session (3) | 2024.10.18 |
| 웹 개발 발전 (4) | 2024.10.15 |