Skip to content

MaeumgaGym GitFlow

박준하 edited this page Jan 18, 2024 · 5 revisions

1. Branch

GitFlow

adsf

  1. 각자 작업할 브랜치를 develop에서 생성합니다.
  • 작업이 길어질 경우, 1) develop checkout 2) Merge develop into 내 브랜치
  • 내 브랜치에 develop를 main처럼 하신다고 생각해주세요
  1. 커밋은 최대한 쪼개서 작성합니다.
  • 이슈를 만들떄도 세세하게 작성해주세요!
  1. 작업이 끝난 후 Pull Request를 통해 Approve를 받은 브랜치를 develop에 merge합니다.
  2. 버전(Release)를 업데이트할 때 main 브랜치를 사용해주세요

Branch Role

main : release 관리, 버전 관리를 위한 브랜치
develop : feature 작업을 합치는 브랜치, 다음 출시 버전을 개발하는 브랜치
feature : 단위 기능을 개발하는 브랜치, 완료되면 develop에 머지됨

Branch naming role

prefix /#issueNumber/ 작업한 view

  • 폴더링
    • feature : 기능 구현
    • network : 네트워크
    • fix : 간단한 수정
    • set : 플젝 세팅과 같은 세팅
    • refactoring : 코드 리펙토링
  • 이슈번호
  • 작업 요약
  • 예시
    • feature/#10-makeShopBanner
    • network/#121-userInformationGet

2. Commit

아이콘 설명 원문
⚙️ 프로젝트 세팅 Project Setting
🎉 프로젝트 시작 Begin a project
⚓️ 새 기능 Introduce new features
💉 성능 개선 Improve performance
🗒️ 문서 추가/문서 수정 Add or update documentation
🚫 코드/파일 삭제 Remove code or files
🥚 버그 수정 Fix a bug
🍗 코드 리팩토링 Refactor code
의존성 추가 Add a dependency
의존성 제거 Remove a dependency
🔀 브랜치 합병 Merge branches
🥊 .gitignore 추가/수정 Add or update a .gitignore file
🏃🏿‍♂️ 리소스 이동, 이름 변경 Move or rename resources
🎮 test 코드 추가 Add Test code
⏱️ 버전 관리 version management
🐞 버그 발생 bug

3. Pull Request

Feature [#이슈번호] 작업 설명

  • Assignee에는 자기 자신 태그
  • Reviewers에 iOS 팀원 태그
  • PR 폼 양식 맞춰서 설명 올리기
  • 스크린샷 필수!

PR Template

작업 내용

  • 작업한 내용 쓰기

PR Point

  • 설명이 필요한 코드나 논의가 필요한 부분을 작성합니다.
  • 코드 넣을 때는 permaLink 사용해보기

스크린샷

  • Gif나 스크린샷 필수로 넣어주세요.

이슈넘버

  • issue: #이슈넘버