Skip to content

GitHub 저장소 관리

Nyeong edited this page Nov 11, 2023 · 2 revisions
  • Git projects 탭을 이용해서 일정과 이슈 관리
  • 위키 페이지 적극 활용하기
  • 커밋 메시지가 한 줄로 설명되지 않으면, body에 적절한 설명을 추가한다.

  • 태그 이름은 다음을 참고한다.

    • Feat: A new feature, 새로운 기능을 추가할 경우
    • Fix: A bug fix, 버그를 고친 경우
    • Docs: Changes to documentation
    • Design: CSS등 사용자 UI 디자인 변경
    • Style: Formatting, missing semi colons, etc; no code change
    • Refactor: Refactoring production code, 새로운 기능이나 버그 수정 없이 현재 코드를 개선한 경우
    • Remove: 사용하지 않는 파일 or 폴더를 삭제하는 경우
    • Rename: 파일 혹은 폴더명을 수정하는 경우
    • Test: Adding tests, refactoring test; no production code change
    • Chore: Updating build tasks, package manager configs, etc; no production code change, package.json의 변경이나 dotenv의 요소 변경 등
  • 예시)

    • #20 Feat: 기능 구현, #24 Fix: 오류 처리 #3 Remove: 사용하지 않는 모듈 삭제
  • 참고: Udacity Git Commit Message Style Guide, 협업을 위한 git 커밋컨벤션 설정하기

  • 기본적으로 GitHub Flow전략을 사용한다.

  • branch명은 아래의 컨벤션을 맞춘다.

master develop-fe develop-be release-* hotfix-* feature/{issue-number}-{feature-name}

  • 예시) feature-#27
  • 이슈 제목 앞에 [FEATURE], [BUG]를 붙이기
  • 라벨 종류 🔨 feature, 🐛 bug, 🛠️ refactor, 🎁 optional, ⚙️ infra, 🍑 UI, ☔️ test, 🐶 docs, 🌈 release

이슈 내용 템플릿

  • feature, refactor, infra..etc
## 📍 구현 기능
- 구현한 기능에 대한 설명

## 🛠 작업 내용
- [ ] todo1
- [ ] todo2
- [ ] todo3

## 📢 추가 의논 사항
- 추가적으로 의논할 사항이나 발생한 에러에 대한 설명

## 🚨 주의 사항
- 구현하며 발견한 주의 사항이나 **꼭 확인했으면 하는 로직**에 대한 설명
  • bug
## 🔍 버그 설명
A clear and concise description of what the bug is.

## 🧐 버그 상황 재현

## 📷 스크린샷(선택)
If applicable, add screenshots to help explain your problem.

## 📜 추가 설명과 의논 사항
Add any other context about the problem here.
  • Todo, In progress, Done 로 나누어 태스크들을 관리