Issue & PR template 관리
.github 디렉토리 생성해서 하위에 관련 md파일 만들어주면 된다.
•
PR Template (.github/PULL_REQUEST_TEMPLATE.md)
## ✅ PR 유형
- [ ] Bugfix
- [ ] Feature
- [ ] Code style update (formatting, local variables)
- [ ] Refactoring (no functional changes, no api changes)
- [ ] Build related changes
- [ ] Other... Please describe:
## #️⃣ 연관된 이슈
> ex) #이슈번호, #이슈번호
## 📝 작업 내용
> 이번 PR에서 작업한 내용을 간략히 설명해주세요(이미지 첨부 가능)
### 💬 리뷰 요구사항 (선택)
> 리뷰어가 특별히 봐주었으면 하는 부분이 있다면 작성해주세요
>
> ex) 메서드 XXX의 이름을 더 잘 짓고 싶은데 혹시 좋은 명칭이 있을까요?
Markdown
복사
•
Issue Template (.github/ISSUE_TEMPLATE/<템플릿 이름>.md)
◦
이슈-생성-템플릿.md
---
name: 이슈 생성 템플릿
about: 해당 이슈 생성 템플릿을 사용하여 이슈를 생성해주세요.
title: 'ex) Feature: ~~기능 추가'
labels: ''
assignees: ''
---
## ✨ 어떤 기능인가요?
> 추가하려는 기능에 대해 간결하게 설명해주세요
## ✅ 작업 상세 내용
- [ ] TODO
- [ ] TODO
- [ ] TODO
Markdown
복사
◦
버그-리포트-템플릿.md
---
name: 버그 리포트 템플릿
about: 해당 버그 리포트 템플릿을 사용하여 버그에 대해 설명해주세요.
title: ''
labels: ''
assignees: ''
---
## 👾 어떤 상황에서 발생한 버그인가요?
> (가능하면) Given-When-Then 형식으로 서술해주세요
## 예상 결과
> 예상했던 정상적인 결과가 어떤 것이었는지 설명해주세요
### 참고할만한 자료 (선택)
Markdown
복사
◦
기타-자유-양식-템플릿.md
---
name: 기타 자유 양식 템플릿
about: "\b자유 양식 템플릿입니다."
title: ''
labels: ''
assignees: ''
---
Markdown
복사
Reference
Issue labels 관리
이것도 원하는 위치에 labels.json 파일 만들어서 관리해주면된다.
[
{
"name": "⚙ Setting",
"color": "e3dede",
"description": "개발 환경 세팅"
},
{
"name": "✨ Feature",
"color": "a2eeef",
"description": "기능 개발"
},
{
"name": "🌏 Deploy",
"color": "C2E0C6",
"description": "배포 관련"
},
{
"name": "🎨 Html&css",
"color": "FEF2C0",
"description": "마크업 & 스타일링"
},
{
"name": "🐞 BugFix",
"color": "d73a4a",
"description": "Something isn't working"
},
{
"name": "💻 CrossBrowsing",
"color": "C5DEF5",
"description": "브라우저 호환성"
},
{
"name": "📃 Docs",
"color": "1D76DB",
"description": "문서 작성 및 수정 (README.md 등)"
},
{
"name": "📬 API",
"color": "D4C5F9",
"description": "서버 API 통신"
},
{
"name": "🔨 Refactor",
"color": "f29a4e",
"description": "코드 리팩토링"
},
{
"name": "🙋♂️ Question",
"color": "9ED447",
"description": "Further information is requested"
},
{
"name": "🥰 Accessibility",
"color": "facfcf",
"description": "웹접근성 관련"
},
{
"name": "✅ Test",
"color": "ccffc4",
"description": "test 관련(storybook, jest...)"
}
]
JSON
복사
0.
위의 labels.json 준비
1.
github-label-sync 설치
npm install -g github-label-sync
Bash
복사
2.
github access token 발급
토큰은 Developer Settings 가서 발급받으면 된다.
3.
repository에 적용
github-label-sync --access-token [액세스 토큰] --labels labels.json [계정명]/[저장소 이름]
Bash
복사
github-label-sync --access-token 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 --labels labels.json oo-ni/NBE1_3_Team9
Bash
복사
github-label-sync --access-token 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 --labels labels.json programmers-be-devcourse/NBE1_3_Team9
Bash
복사
