CPR 협업룰 - choigiseong/baseball GitHub Wiki

Rules

1. Branch Rules

branch 만들 때  team16 > dev > BE > feature_BE/XXX  (feature 브랜치 이름 - feature_BE/IssueNum)
                               FE > feature_FE/XXX  (feature 브랜치 이름 - feature_FE/IssueNum)

2. Commit Message Rules

feat : 새로운 기능 추가
fix : 버그 수정
docs : 문서의 수정
style : (코드의 수정 없이) 스타일(style)만 변경(들여쓰기 같은 포맷이나 세미콜론을 빼먹은 경우)
refactor : 코드를 리펙토링
test : Test 관련한 코드의 추가, 수정
chore : (코드의 수정 없이) 설정을 변경
예시
- feat: 헤더 컴포넌트 완성
- docs: README.md 파일 일부 수정

3. Code Review Rules (분업 시, PR 날릴 때 참고!)

저장소 내에서 PR 날리고, 서로 코드리뷰를 할 때 궁금한 부분이 있다면 해당 부분 선택하여 질문 남기기.
- 이 경우 코멘트 태그는 P5 그게 아니더라도 다양하게 써도 됌!
어떤 부분이 이상하다면, 아래 코멘트 태그를 붙이며 이유를 말해주기!

리뷰어가 썼던 코멘트

P1 : 꼭 반영해주세요 (Request changes)
P2 : 적극적으로 고려해주세요 (Request changes)
P3 : 웬만하면 반영해주세요 (Comment)
P4 : 반영해도 좋고 넘어가도 좋습니다 (Approve)
P5 : 그냥 사소한 의견입니다. (Approve)

4. Projects, Milestone, Issues

Projects
- 프로젝트는 FE, BE 모두 한 공간에서 사용!
  - 현재 Projects는 CPR 야구게임이라는 이름으로 생성되어 있음
- To do 부분에는 작성했던 Issues들이 있을 것.
  - 작업 시작할 때 In Progress 로 드래그해놓기!
Milestone
- 마일스톤은 어떠한 작업을 시작할 때 꼭 만들기!! (Issue 만들기 전에!)
- 예시
  - 헤더를 만들려한다. ▶ [FE] 헤더 만들기 라는 이름으로 마일스톤 생성
  - Due date는 설정해도 안해도 됨!! (일종의 데드라인 정해놓는 것!)
    - 진행상황 보면서 데드라인 정할 수도 있음!
Issues
- Issue를 만들 때는 어떠한 Milestone에 포함되어야 함. (위 과정에 써있듯, Milestone을 만들고 작업)
- 예시 (위 Milestone 예시와 이어짐)
  - 헤더 관련한 Milestone을 만들었다.
  - Issues 탭으로 이동하여 New issue를 클릭하여 이슈를 발행
  - Issue의 Nav (우측의 기타 설정들!)
    - Assignees: 작업을 처리할 사람 (담당자)
    - Labels: 눈에 명확하게 보이는 라벨 설정 (라벨)
      - FE BE bug 등 다양한 라벨이 있음! 해당하는 것 등록해주기!
    - Projects: 프로젝트, 현재 진행하고 있는 프로젝트 선택!
      - 여기서 Projects를 선택해주면, 해당 Projects의 To do 구역으로 넣어짐!
    - Milestone: 마일스톤, 마지막으로 위에서 만든 Milestone을 등록해줌!
  - Issue의 내용을 작성할 때엔 가급적으로 체크박스를 사용해주세요!! (제일 작은 단위를 뜻함!)
    - 마크다운 문법의 체크박스!
```
- [ ] 난 체크안된 체크박스야!!
- [X] 난 체크된 체크박스!!
```
Milestone, Issues, checkboxs..?
- 간단하게 보면 제일 큰 틀은 Milestone
- 다음은 Issues
- 마지막은 Issue안의 checkboxs

5. 이미지로 보는 설명

브랜치 규칙

프로젝트 관리 (Milestone, Issues, checkboxs)