📌 Github 문서 사용 컨벤션
이슈 + 프로젝트 + 디스커션 + PR
이슈 등록 ( 템플릿 사용)
- 제목: 기능 태그( feat, fix, refactor, style…) + 설명
feat: 자동로그인 session 으로 구현
- 프로젝트 지정
- 만약 pr 단위가 아니라 좀 더 세분화했다면 milestone에 단위 쓰기
- sprint 단위로 기간 동안 할 일 모두 작성 ⇒ 칸반보드에서 팀원의 잔업량 확인위해
예시
만약 이슈를 세분화했다면 아래처럼 마일스톤으로 묶기 ( 자율 )
- 마일스톤:
로그인 기능 구현
- 이슈
-
로그인 폼 구축 로그인 커스텀 훅 구축로그인 자동화 세션으로 구현
코발트 이슈 사용예시
- 저희의 이슈는 크게 4가지 입니다. 버그, 개선, 기능, 리팩토링
- 이슈 라벨을 다음과 같이 정했습니다. (개선, 기능, 버그, 디자인, 에픽, 리팩토링, 릴리즈, 문서)
- 이슈에 따라 문서를 다르게 적습니다.
- 개선이면 기존과 무엇이 개선이 되었는지, 연관된 이슈가 무엇인지,
- 버그라면 버그설명, 재현경로, 필요하다면 스크린샷 등 어떤 환경에서 버그가 발생되었는지.
- 그리고 연관된 이슈가 있으면 같이 링크를 걸어주고, 이 이슈의 pr이 생긴다면 linked pull request에 pr을 연결합니다.
이슈 템플릿 예시
필요한 부분만 작성 후 나머지 삭제
### 기능 이슈 #### 제목: \[feature\] 기능이름 #### 기능: <!-- 기능을 설명해주세요. --> #### 기능 세부 설명: <!-- 세부적인 설명을 설명해주세요. --> #### 기타 <!-- 버그 발생시 활용! --> ### 버그 이슈 #### 제목: \[bug] 에러명 #### 어디에서 <!-- 버그가 발생된 위치 --> #### 의도했던 상황 <!-- 의도하고자 했던 상황을 설명하세요 --> #### 현재 상황 <!-- 예시: 상황이 발생하는 대략적인 진행 사항을 단계적으로 설명 해주세요. --> #### 어떤 버그가 ( 에러메시지 ) <!-- 에러메시지를 넣어주세요. -->
milestone 생략
fix, refactor 요청시 이슈 만들어서 요청
프로젝트
- No status의 이슈들 자신의 보드로 옮기기
- 2시에 진행하는 스크럼 시간에 진행상황 말하기
- 진행상황에 따라 todo, inprogress, done에 넣어두기
예시
( 전체는 디스커션 사용 안함, FE끼리만 사용 )
디스커션
- 프로젝트 관련 질문, 논의 사항이 생기면 여기에 문서화
- bug, 긴급 라벨 사용 예정
- 작성 후 긴급한 건 슬랙에 리뷰 요청
- 아니라면 6시 회의에 언급 하고 다음날 2시까지 답변 받기
pr (템플릿 사용)
- 배포, 긴급 라벨 사용 예정
- 담당이 리뷰 but 긴급은 선착순
- 긴급 라벨이 붙는 pr은 6시 전까지 리뷰 ( 슬랙으로 요청 )
- 6시쯤 올렸다면 당일까지 리뷰
- resolve #이슈번호
pr 템플릿 예시
## PR 템플릿 ## ✅ 이슈 번호 ## 📌 기능 설명 <!-- 기능을 대략적으로 설명해주세요 --> ## 👩💻 요구 사항과 구현 내용 <!-- 요구 사항과 실제 구현 내용을 작성해 주세요 --> ## 구현 결과 <!-- 이미지를 첨부해주세요. --> <!-- issue 클로즈시, resolve 명시 ex: resolve #이슈번호 - 기능 이슈 fix #이슈번호 - 버그 이슈 close #이슈번호 - etc 이슈 -->