커밋 컨벤션, 컴포넌트명 컨벤션 정하기
Type | 설명 |
Add | 외부 모듈, 라이브러리 설치 |
Feat | 기능 추가 및 변경 |
Fix | 오류를 고쳤을 때, 버그 수정 |
Style | 코드 스타일 포맷팅(세미콜론, 탭) |
Design | CSS, UI 디자인 |
Refactor | 코드 리팩토링, 기능 상 변화 없이 가독성과 유지보수성 |
Comment | 주석 추가 및 변경 |
Test | 테스트를 위한 커밋 |
Docs | README 및 github wiki 등 문서 내용 수정, |
Merge | 수정 없이 GitHub 기본 메시지 사용 |
Rename | 폴더명, 파일명 등의 변경, 디렉터리 이동 |
Remove | 파일을 삭제하는 작업 수행 |
ETC | 위 분류에 넣기 애매한 기타 변경사항(빌드 스크립트 수정 등) |
chore랑 post, remove 넣을지?
refac 안에 함수명 변수명 다 들어가는 것? > 변수, 함수명 변경까지 포함
커밋 메시지 작성법
### 제목
# 커밋 타입: 작업내용
### 본문 - 한 줄에 최대 72 글자까지만 입력하기
# 무엇을, 왜, 어떻게 했는지
# 본문에 여러줄의 메시지를 작성할 땐 "-"로 구분했나요?
Markdown
복사
컨벤션을 따르려고 하되 변경점 쉽게 알 수 있도록 충분히 자세하게 작성되기만 하면 컨벤션을 엄격하게 지키지 않아도 문제없는 걸로
1.
제목 (필수)
Feat: 메인 페이지 아이콘 svg으로 교체
Plain Text
복사
2.
본문 (선택) 무엇을 왜 했는지
이슈 템플릿
간단한 할 일을 작성할 경우의 템플릿
// current_issue
## SUMMARY
이슈에 대한 요약을 작성해주세요.
## CHECKLIST
- [ ] task1
- [ ] task2
## ETC
이 외 특이사항을 명시해주세요.
진행되어야 할 사항들, 할 일 체크리스트 만들어서 관리
Markdown
복사
// feature_request
---
name: Feature request
about: Suggest an idea for this project
title: ' OO 기능 요청'
---
## 기능 요청사항
ex) 로그인 기능이 필요해요.
## 요청 세부사항
ex) Jwt 를 활용해서 로그인 기능을 만들어주세요.
## 레퍼런스
ex) 관련 사진 및 링크 첨부
Markdown
복사
이슈에 적힌 내용 작업 완료되면 PR날리고 확인 후 merge
PR 템플릿
// PULL_Request_template
### 📝 제목
ex) OO 기능 구현
### 💽 Commits
ex)
구현 사항 요약
1. OO 구조 설계
-추가 설명
2. OO 클래스 분리
-추가 설명
3. 메서드 구현
-추가 설명
### 🖼 결과
ex) 실행 결과 간략히 설명
## 이슈 번호
closed: #1
Markdown
복사
버그 발생 시 템플릿
**버그 설명,스크린샷(optional)**
---
**수정계획**
---
**수정완료 후 예상동작**
---
**특이사항**
---
Markdown
복사
유정님 PR 템플릿
## 🍀 무엇을 위한 PR인가요?
- [ ] 기능 추가 :
- [ ] 스타일 :
- [ ] 리팩토링 :
- [ ] 문서 수정 :
- [ ] 버그 수정 :
- [ ] 기타 :
## 🍀 기대 결과
-
## 🍀전달사항
-
## 🍀스크린샷
## 🍀Issue Number
close : #
Markdown
복사
네이밍 컨벤션 12/08 목
이번주 목요일 깃헙 특강 있으니 이번 주 내로 PR 날리고 merge, issue, 템플릿 연습
fast-forward merge: 브랜치 한 단계 앞에 가 있으면 merge 불가능 (merge 시 branch가 꼬임)
https://coding-start.tistory.com/333 “-f” 명령어 사용
디자인 만지고 하려면 주제 빨리 정해지는게…?
