Skip to content

✍️ GitHub Convention

Seolmin Moon edited this page Nov 6, 2024 · 2 revisions

Git 브랜치 전략

  • GitHub Flow를 사용해요.
  • main 브랜치는 배포를 위한 브랜치에요.
  • dev-be, dev-fe는 백엔드, 프론트엔드를 위한 브랜치에요.
  • feature/#issue는 이슈 번호에 해당하는 구현을 위한 브랜치에요.
gitGraph
    commit
    branch dev-be
    branch dev-fe
    checkout dev-be
    branch "feature/#1"
    commit
    commit
    checkout dev-be
    merge "feature/#1"
    checkout main
    checkout dev-fe
    branch "feature/#2"
    commit
    commit
    checkout dev-fe
    merge "feature/#2"
    checkout main
    merge dev-be
    merge dev-fe
Loading

Commit

  • 하나의 기능에 대해서 구현과 테스트를 묶어서 commit해요.

Issue

  • Assignees를 명시해야 해요.
  • 주어진 템플릿을 사용하여 형식을 지켜요.
  • 기능 관련 Issue라면 GitHub Project와 연동해요.
  • Feature Issue에서 FE, BE가 불분명하면 담당자가 얘기를 나누고 분리해요.
  • Story Issue는 해당하는 Issue들이 완료되면 수동으로 Close해요.

Issue Labels

Label 설명
🥰 accessibility 웹 접근성
📪API 서버 API
💻 cross browsing 브라우저 호환성
🌏 deploy 배포 설정
✨feature 기능 개발
🎨 html&css 마크업 & 스타일링
🐞 bugfix 버그
🙋‍♂️ question 정보 요청
🔨 refactor 리팩토링
⚙setting 개발 환경 설정
✅ test 테스트 관련
story 태스크들을 포함하는 스토리

PullRequest

  • 제목은 "[#issue] 제목"으로 작성해요.
  • merge 전에 코드 리뷰를 진행해요.
  • merge 전에 2개의 approve를 받아야해요.
  • 템플릿으로 형식을 지켜요.
Clone this wiki locally