Skip to content

컨벤션 규칙

ez edited this page Oct 28, 2024 · 1 revision

커밋

타입 설명
feat 새로운 기능 추가
fix 버그 수정
refactor 새로운 기능 추가와 관련 없는 코드 개선 작업
chore 의존성 관리, 빌드, 배포 등 개발 환경에 관련된 작업
design css 관련 코드 작업 및 UI에 변경사항이 있는 경우
test 테스트 코드 작성
docs 문서 작성
perf 성능을 개선하는 코드 변경
ex)
feat: Oauth2 기능 추가
---
.gitmessage 파일을 통해 템플릿으로 관리
[키워드:소문자]: [커밋 메시지: 한글로 이번 커밋 작업 내용 요약]
- [세부 작업 내용 설명]
- [맥락 설명도 좋습니다!]
<공백>
- [관련된 이슈? #1]
  • 커밋은 기본적으로 제목만 작성하고 추가적인 설명이 필요할 때만 내용까지 작성합시다.

이슈

## 어떤 버그인가요?

> 어떤 버그인지 간결하게 설명해주세요

어떤 상황에서 발생한 버그인가요?

> (가능하면) Given-When-Then 형식으로 서술해주세요

예상 결과

> 예상했던 정상적인 결과가 어떤 것이었는지 설명해주세요

참고할만한 자료(선택)

https://github.com/boostcampwm2023/web18_Dandi/issues?page=2&q=is%3Aissue+is%3Aclosed

필수? 라벨 : FE, BE

라벨 : Bug, Feature

  • 기능 추가

    <!-- 기능 추가 이슈>
    ## 어떤 기능인가요?
    

    > 추가하려는 기능에 대해 간결하게 설명해주세요

    작업 상세 내용

    • TODO
    • TODO
    • TODO

    참고할만한 자료(선택)

  • PR

    ## #️⃣연관된 이슈
    

    > ex) #이슈번호, #이슈번호

    📝작업 내용

    > 이번 PR에서 작업한 내용을 간략히 설명해주세요(이미지 첨부 가능)

    스크린샷 (선택)

    💬리뷰 요구사항(선택)

    > 리뷰어가 특별히 봐주었으면 하는 부분이 있다면 작성해주세요 > > ex) 메서드 XXX의 이름을 더 잘 짓고 싶은데 혹시 좋은 명칭이 있을까요?

브랜치 전략

개발 문서

⚓️ 사용자 피드백과 버그 기록
👷🏻 기술적 도전
📖 위키와 학습정리
🚧 트러블슈팅

팀 문화

🧸 팀원 소개
⛺️ 그라운드 룰
🍞 커밋 컨벤션
🧈 이슈, PR 컨벤션
🥞 브랜치 전략

그룹 기록

📢 발표 자료
🌤️ 데일리 스크럼
📑 회의록
🏖️ 그룹 회고
🚸 멘토링 일지
Clone this wiki locally