Skip to content

[BE] Git

haeyong Hahn edited this page Jan 15, 2025 · 2 revisions

🌊 Git Flow

main : 제품으로 출시될 수 있는 브랜치
develop : 다음 출시 버전을 개발하는 브랜치
feature : 기능을 개발하는 브랜치
release : 이번 출시 버전을 준비하는 브랜치
hotfix : 출시 버전에서 발생한 버그를 수정 하는 브랜치

255449417-72151923-1405-409f-b658-9777895bbb14

🤝 Commit Convention

Git Template 설정 - Git Template

[Type] [Title] (#이슈번호)
# 한줄 띄우기
[Body] (본문)

이슈번호가 없다면,

[Type] [Title]
# 한줄 띄우기
[Body] (본문)

[Type] 입력 목록

  1. Feat : 새로운 기능 추가
  2. Fix : 오류 해결
  3. Rename : 파일 혹은 폴더명을 수정만 한 경우
  4. Remove : 파일을 삭제만 한 경우
  5. Style : 기능 수정 없이 코드 스타일만 변경한 경우 (코드 포맷팅, 세미콜론 누락 등)
  6. Design : 사용자 UI 디자인 변경 (CSS 등)
  7. Refactor : 코드 베이스 특정 부분을 재정렬 (Refactoring)
  8. Test : 테스트와 관련된 모든 것
  9. Docs : 문서화에 관한 모든 것
  10. Chore : 빌드 업무 수정, 패키지 매니저 수정 (gitignore 수정 등)
  11. Perf : 성능 개선

[Title] 규칙

  1. 50자 이내 짧은 요약
  2. 명령형으로 작성
  3. 제목 끝에 .(마침표) 금지

[Body] 작성 규칙

  1. 제목과 본문 사이 빈 칸 한줄 필수 (제목과 본문 분리)
  2. 생략 가능, 필요 시 자세한 설명 작성 (72자 내외로 마무리)
  3. 적용한 변경사항과 그것을 만든 이유에 대해 설명. 어떻게 보다는 "무엇을", "왜"

예시

[Fix] CI 파이프라인 수정 (#6)

모듈이 추가될 때, 추가된 모듈을 자동으로 찾아서 CI 가 돌아갈 수 있도록 수정

🌳 Branch Naming Role

main, develop

main 과 develop 브랜치는 본래 이름 그대로 사용한다.

feature

feature/기능요약 : feature/common, feature/shop, feature/order, ...

release

release/v버전 : release/v0.0.1, ...

hotfix

hotfix/오류발견버전 : hotfix/v0.0.1, ...

🏠 Home

🔙 BackEnd

🤔 요구사항 분석

요구 사항 분석 Ver.1
요구 사항 분석 Ver.2

🗳️ 프로젝트 구조

프로젝트 구조 Ver.1
프로젝트 구조 Ver.2
프로젝트 구조 Ver.3

🔀 다이어그램

◀️ 시퀀스 다이어그램
시퀀스 다이어그램 Ver.1
시퀀스 다이어그램 Ver.2

🗳️ 컴포넌트 다이어그램
컴포넌트 다이어그램 Ver.1

🏗️ 인프라 다이어그램
인프라 다이어그램 Ver.1
인프라 다이어그램 Ver.2 - dev
인프라 다이어그램 Ver.3 - prod

🔗 CI / CD

배포 파이프라인 구성 Ver.1 ‐ dev
배포 파이프라인 구성 Ver.2 - prod

🖥️ 모니터링

클라이언트 앱 서비스 Grafana 모니터링

📖 API 문서화

서버에 문서를 반영해야 프론트 개발자 분들께서 확인할 수 있는 번거로움을 줄이기 위하여 Notion 으로 API 를 문서화하도록 변경했습니다.
Swagger Docs
Notion API 문서화

❓ 문제 해결 고민

👩🏽‍🏫 멘토링 일지


O2O 개발의 민족 스토리

개발의 민족 프론트엔드 팀 :
@박용석 @전수현 @이영률 @정연희

INNER CIRCLE MVP 발표자 :
@이영률 @신용진 🥇

INNER CIRCLE 최종 발표자 :
@박용석 @신용진 🏆

Clone this wiki locally