Issue
issue 발행 할 땐 간단하게 할 것 요약
git branch 생성 후 사용
저희는 기본적으로 main은 배포 전 완전 마지막 branch이고 보통 dev라는 branch에서 보통 코드를 취합합니다. 그래서 dev의 코드를 pull로 당겨온 다음
branch명은 명확할 수록 좋습니다!
이렇게 push를 시키고 github에 PR 올리러
저희는 feat/rankingpage-markup을 만들었으니
dev <- feat/rankingpage-markup
만약 컨벤션이 있다면 이렇게 나오게되는데 없다면 입력하면 됩니다.
필요한 부분만 빼고 지워줍니다. 저가 하는 방식은
// - [] 이렇게 입력하면 체크박스 됨
쓸건 쓰고 지울 건 지워서
이런 식으로 작성하면 됩니다. 이때 PR은 자세히 적어줄 수록 좋습니다.
보통
🛠️ 해야할 일
- 사진 첨부
순으로 적는 편인 것 같습니다.
우측에 있는거 선택할거 선택해 주시고 하면 끝이 납니다.
또 같은 팀원의 PR approve, comment를 남길 때
PR에 보시면 이렇게 나오는데 저기 Files changed << 4번째꺼 누르고 들어 가셔서
우측에 나오는 초록색 Review changes
Comment나 Approve등 "확인했습니다!" 같은거 남겨주실 내용 남겨주면 됩니다.
이 밑에 컨벤션들 두겠습니다
PR 컨벤션
---
name: PR Template
about: Check the pull request
title: ""
labels: ""
assignees: ""
---
<!---
# 뒤에 머지 후 close할 이슈번호를 작성
# 자동으로 close 됩니다.
<strong>
Closes #
</strong>
--->
### 💡 다음 이슈를 해결했어요.
- (가능한 한 자세히 작성해 주시면 도움이 됩니다.)
<br><br>
### 💡 이슈를 처리하면서 추가된 코드가 있어요.
- (없다면 이 문항을 지워주세요.)
<br><br>
### 💡 필요한 후속작업이 있어요.
- (없다면 이 문항을 지워주세요.)
<br><br>
### 💡 다음 자료를 참고하면 좋아요.
- (없다면 이 문항을 지워주세요.)
<br><br>
### ✅ 셀프 체크리스트
- [ ] 브랜치 전략에 맞는 브랜치에 PR을 올리고 있습니다. (master/main이 아닙니다.)
- [ ] 커밋 메세지를 컨벤션에 맞추었습니다.
- [ ] 변경 후 코드는 컴파일러/브라우저 warning/error 가 발생시키지 않습니다.
- [ ] 변경 후 코드는 기존의 테스트를 통과합니다.
- [ ] 테스트 추가가 필요한지 검토해보았고, 필요한 경우 테스트를 추가했습니다.
- [ ] docs 수정이 필요한지 검토해보았고, 필요한 경우 docs를 수정했습니다.Issue 컨벤션
Feature 템플릿
## 💡 작업할 내용
(작업할 내용을 입력해주세요)
## 🛠 작업 상세 내용
- [ ] 작업 2-1
- [ ] 작업 2-2
<br>
## 💡 참고자료
- (없다면 이 항목을 지워주세요.)
**Additional context**
Add any other context or screenshots about the feature request here.
Bug 템플릿
## 개요 및 증상
- 버그 발생 일시:
- 버그 발생 위치:
- 기대한 동작
- (어떻게 동작할 것이라고 기대했는지 작성합니다.)
- 실제 동작
- (실제로 어떻게 동작했는지 작성합니다.)
<br>
## 스크린샷 (필요 시)
<br>
## 버그 재현 방법
1. '...'에 간다.
2. '....'를 클릭한다.
3. '....'까지 스크롤을 내린다.
4. 에러를 확인한다.
<br>
## 환경 정보
- [ ] Desktop:
- OS: [e.g. iOS]
- Browser [e.g. chrome, safari]
- Version [e.g. 22]
- [ ] Smartphone:
- Device: [e.g. iPhone6]
- OS: [e.g. iOS8.1]
- Browser [e.g. stock browser, safari]
- Version [e.g. 22]
