Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Collaboration Guide] #1

Open
529539 opened this issue Jul 12, 2023 · 0 comments
Open

[Collaboration Guide] #1

529539 opened this issue Jul 12, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@529539
Copy link
Contributor

529539 commented Jul 12, 2023

Branch

  • 자신의 GitHub 아이디의 branch에서 각자 작업
  • 원한다면 fork 후 기능별 branch를 분리해 작업한 뒤 upstream branch로 pr 가능 (작업 방식 자유)
  • dev branch에 merge
  • main branch는 사용 안함, 프론트 배포 이후로만 pr 후 merge

Commit Convention

commit message는 {type} : description 형태로 작성
ex) ✨ : Header 컴포넌트 작성

types

Gitmoji 의미 내용
feat 새로운 기능 추가
🐛 bug 버그 수정
🎨 style 코드 포맷팅, 오타 수정, 주석 수정 및 삭제 등
📦️ package 빌드 및 패키지 수정 및 삭제 (npm i)
🔀 merge 브랜치 머지
test 테스트 코드
📝 docs 문서(리드미) 수정
🍱 asset asset 파일(이미지, 아이콘 등) 추가

Pull Request

  • 모든 PR은 팀원 간 상호 확인 필수 (GitHub 모바일 앱으로 PR 알림을 받거나, Slack 등으로 알리기)
  • PR title 말머리는 [Feature], [Fix], [Enhance], [Chore] 등과 같이 사용
  • [Chore]과 같은 간단한 PR의 경우 직접 merge 가능

PR template

# 구현 기능
- 구현한 기능을 요약하여 정리합니다.

# 구현 상태
- img, gif, video...
- 혹은 내용 정리

# Resolve
- 이슈 태그(ex: #7)

# To Reviewers
- 팀원들에게 전달할 점 (ex 공용 컴포넌트나 훅스 작성)
@529539 529539 added the documentation Improvements or additions to documentation label Jul 12, 2023
SSSSSSu3834 added a commit that referenced this issue Jul 25, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant