Skip to content

Instantly share code, notes, and snippets.

@ljlm0402

ljlm0402/Commit Convention.md

Last active September 28, 2022 13:11
Show Gist options
  • Save ljlm0402/e34746aba9f1fd1e38221ed13c46a70d to your computer and use it in GitHub Desktop.
Save ljlm0402/e34746aba9f1fd1e38221ed13c46a70d to your computer and use it in GitHub Desktop.
Download ZIP
개발 룰 & 컨벤션
Raw
Commit Convention.md 
# <타입>: [FE/BE]<제목>

##### 제목은 최대 50 글자까지만 입력 ############## -> |


# 본문은 위에 작성
######## 본문은 한 줄에 최대 72 글자까지만 입력 ########################### -> |
- 본문 내용

# 꼬릿말은 아래에 작성: ex) #이슈 번호

# --- COMMIT END ---
# <타입> 리스트
#   feat    : 기능 (새로운 기능)
#   fix     : 버그 (버그 수정)
#   refactor: 리팩토링
#   test    : 테스트 (테스트 코드 추가, 수정, 삭제: 비즈니스 로직에 변경 없음)
#   chore   : 기타 변경사항 (빌드 스크립트 수정 등)
# ------------------
#     제목 첫 글자를 대문자로
#     제목은 명령문으로
#     제목 끝에 마침표(.) 금지
#     제목과 본문을 한 줄 띄워 분리하기
#     본문은 "어떻게" 보다 "무엇을", "왜"를 설명한다.
#     본문에 여러줄의 메시지를 작성할 땐 "-"로 구분
# ------------------
Raw
Issue Template.md

✨ Feature Issue

## 💁 설명
- Github 이슈 설명

## 📑 체크리스트
> 구현해야하는 이슈 체크리스트

- [ ] 체크 사항 1
- [ ] 체크 사항 2
- [ ] 체크 사항 3
- [ ] 체크 사항 4

## 🚧 주의 사항
> 이슈를 구현할 때 유의깊게 살펴볼 사항

- 주의 사항 1
- 주의 사항 2

🐞 Bug Issue

## 💁 설명
- 버그 제보 (가능하면 버그 시나리오를 상세히 적어주세요)

## 🎬 시나리오
1.
2.
3.

## 📢 예상 결과
- 정상동작 했을 때 결과를 적어주세요

## 🃏 실제 결과
- 버그가 발생한 현재 동작 결과를 적어주세요

## 📸 스크린샷
- 가능하다면 오류메세지나 동작결과에 대해 스크린샷을 첨부해주세요
Raw
PR Convention.md

💪 PR Convention

## 📕 제목

PR 제목
관련이슈 #00, .....

## 📗 작업 내용

> 구현 내용 및 작업 했던 내역

- [x] 작업내용1
- [x] 작업내용2
- [x] 작업내용3

## 📘 PR 특이 사항

> PR을 볼 때 주의깊게 봐야하거나 말하고 싶은 점

- 특이사항1
- 특이사항2
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment