깃 컨벤션 - boostcampwm2023/baekjoonrooms GitHub Wiki

브랜치 전략

Git Flow 전략 사용

출처: https://blog.kinto-technologies.com/posts/2023-03-07-From-Git-flow-to-GitHub-flow/

사용할 브랜치

  • release
  • develop
  • feat
  • hotfix
feat 브랜치 네이밍
- 영어 소문자, 하이픈 띄어쓰기(kebab-case)
- 예시 : `feat/new-feature-name, feat/hello-controller/get`

커밋 컨벤션

  • Type

    • test — 테스트 코트, 리펙토링 테스트 코드 추가
    • feat — 기능 추가 및 수정
    • fix — 버그 수정
    • chore — 빌드 관련
    • docs — 문서 변경
    • refactor — 코드 리펙토링
    • style — 코드 포맷팅, 세미콜론 누락, 주석 작성 등 코드 변경이 없는 경우

  • 커밋 메시지와 바디는 한글로 적어요.

  • 커밋 예시 

    feat: Github 로그인 기능 추가

Github OAuth 로그인 구현

  • commitizen이라는 것도 한번 살펴보세요.

이슈 컨벤션

---
name: Feat
about: 프로젝트 개발 기능 이슈
title: "Feat"
labels: "✨ Feat"
---

## 💎 개발할 기능

<!-- 어떤 기능을 구현할지 알려주세요. -->

- [ ] feat-1

## 📖 참고 사항

<!-- 레퍼런스, 스크린샷 등을 넣어 주세요. -->

PR 컨벤션

비공식: commit 메세지들을 모아서 chatgpt에 넣기

  • PR 템플릿에 맞춰서 작성해요.
  • PR 제목은 브랜치명 : PR에 대한 간단한 요약으로 작성해요.
  • 리뷰이는 리뷰어를 배려해 최대한 자세히 상세히 열심히 작성해요.
<!-- Review the checklist below before submitting -->

## Checklist

- [ ] **Code Review:** 작성한 코드를 다시 한 번 꼼꼼이 확인했나요?
- [ ] **Testing:** 앱이 잘 구동되는지 개발한 기능이 문제 없이 작동하는지 확인했나요?
- [ ] **Remove:** print나 주석 등 필요없는 코드를 삭제했나요?
- [ ] **Rebase:** (필요시) rebase를 완료했나요?
- [ ] **Conflict Resolution:** 충돌을 해결하는 과정을 거쳤나요?
- [ ] **New Dependencies:** 새로운 dependency를 추가했나요?

<!-- Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context -->

## Description

<!-- List core changes that were made in this pull request -->

## Changes Made

<!-- Concerns, etc. -->

## Extra Comments

<!-- If applicable, add screenshots to help explain your changes -->

## Demo

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”
나에게 좋다는 의미로 사용. 시스템의 프로토 타입을 만들어 테스트 할 때, 자신의 환경에서 잘 움직일 때, 또는 의견 조정시에 나에게 고마운

코드 리뷰 및 머지 컨벤션

  • 코드 리뷰 시에는 칭찬할 점을 꼭 하나 이상 찾아주세요.
  • 코어 타임 이내에 올라온 PR은 최대한 빠르게 리뷰를 해주어요.
  • 코어 타임 이후에 올라온 PR은 데일리 스크럼이 끝난 직후 리뷰를 해주어요.
  • 다른 분야의 PR이라도 간단하게나마 읽어보는 것을 권장해요.
  • 모든 PR은 각 분야의 모든 동료들의 approve를 받아야 Merge할 수 있어요.
  • merge 방식같은 경우, 기본적으로 merge로 하고 로컬에서는 때때로 편하게 rebase해요.
  • 본인의 PR은 스스로 Merge해요.
  • Merge 독촉은 웰컴!