Skip to content

깃허브 컨벤션

백도훈 edited this page Nov 7, 2022 · 3 revisions

1. Issue

  1. 이슈 템플릿에 맞춰서 작성해요.
---
name: Feat
about: 프로젝트에 관한 모든 아이디어, 기능을 적어주세요!
title: "[Feat]"
labels: "\U0001F4BB Feature"
assignees: ''
---

## 💡 개요
이슈의 개요를 적어주세요.

## 🤩 기능 설명
개발할 기능에 대해서 말씀해주세요.

## 🍒 세부 기능
어떤 세부 기능을 구현할지 말씀해주세요.
- [ ] feature_detail 1
- [ ] feature_detail 2

## 📖 참고 사항
공유할 내용, 레퍼런스, 추가로 발생할 것으로 예상되는 이슈, 스크린샷 등을 넣어 주세요.
- 추가적으로 필요한 내용은 comment로 남겨주세요.

2. Branch

  1. 브랜치는 배포용 브랜치인 main 브랜치와 개발용 브랜치인 dev 브랜치(default 브랜치)로 나눠서 사용해요.
  2. 브랜치 생성 규칙은 {prefix}/#{issue number}-{성 이니셜} 에 맞춰서 작성해요.
    1. feat/#10-B feat/#12-S feat/#13-K

3. Commit

  1. 커밋 메세지 규칙에 맞춰서 작성해요.
feat: 뭐뭐뭐를 함 (이유 말고 이게 뭔지 - 코드 동작에 대한 설명)

---
body -> 뭐뭐뭐 해결을 위해 뭐뭐 사용(필요한 경우 이유 설명, 원희체 사용, 원희템플릿 따라서)

---
Resolve: #이슈 번호
See also: #이슈 번호
Co-authored-by: se030
Co-authored-by: dohun31

4. Pull Request

  1. PR 템플릿에 맞춰서 작성해요.
  2. 리뷰이는 리뷰어를 배려해 최대한 자세히 상세히 열심히 작성해요.
## 개요

<!-- 

- 이슈번호
- 한줄 설명
 
-->

## 설명

<!-- 

- 현재 Pr 설명 

-->

## 고민거리 (Optional) - 의견 받고싶은 부분 있으면 적어두기

<!-- 

### Q. 고민1
뭐시기 뭐시기 

-->

## 스크린샷 (Optional, Highly recommended by ***dohun***)
AFAIK - “As Far As I Know”
내가 아는 한.

FYI - “For Your Information”
참고로 라는 뜻. 웹상에서 마음에 드는 기사 나 뉴스가 보일때 , FYI라는 말과 함께 링크 URL을 보낼 때 등에 자주 사용된다.

IMO (IMHO) - “In My (Humble) Opinion”
개인적인 의견 입니다만, 내 소견이지만. (humble 이 들어가면 조금 겸손한 느낌)

**LGTM** - “Looks Good To Me”
okay, 개발 한 시스템과 코드 리뷰를 부탁하거나, 자료의 요약을 확인 갔을 때 특별한 문제가없는 경우에 사용함.

**TBD** - “To Be Determined”
결정되지 않은 부분에 “나중에 결정할 것”이라고 말했다 뉘앙스.

TL;DR. - “Too Long. Didn’t Read”
장문의 시작 부분에 “장문이므로 요약 올립니다”라는 느낌으로 사용.

WFM - “Works For Me”
나에게 좋다는 의미로 사용. 시스템의 프로토 타입을 만들어 테스트 할 때, 자신의 환경에서 잘 움직일 때, 또는 의견 조정시에 나에게 고마운

5. Prefix