2024-06-18 Github Label Setting, Issue 설명 추가
🏷️ Github Label Setting
Github 액세스 토큰 발급
https://github.com/settings/tokens
토큰은 만들고나면 보이지않으니 저장해야합니다.
- Generate new token 클릭
- 원하는 이름 입력
- scopes에서 repo 선택
🏷️Label 정의하기
Label Sync 도구를 사용하여 labels.json에 담긴 내용을 동기화 합니다.
JSON Array 형태로 정의하며, name, color, description을 정의할 수 있습니다.
[
{
"name": "Priority: Critical",
"color": "8c001a",
"description": "우선순위 긴급"
}
]💡NPM 준비
- Node.js 설치
- 터미널 창으로 접속하여 node -v, npm -v로 설치가 잘되었는지 확인
🏷️Label Sync
npm install -g github-label-sync해당 명령어를 이용해 github-label-sync 패키지를 전역으로 설치합니다.
npx github-label-sync --access-token [액세스 토큰] --labels labels.json [계정명]/[저장소 이름]각 부분에 맞는 정보를 채워넣어 라벨을 동기화합니다.
동기화가 완료된 모습입니다.
🚩 Github Issue
Git Issue는 Git 저장소에서 버그, 기능 요청, 개선 사항 등을 추적하기 위해 사용되는 기능입니다.
주로 GitHub, GitLab, Bitbucket과 같은 Git 호스팅 서비스에서 제공됩니다.
Issue는 프로젝트와 관련된 다양한 주제에 대해 토론하고 협업할 수 있는 공간을 제공합니다.🚩Issue 주요 기능과 사용방법
- 라벨(Label):
- Issue에 라벨을 붙여 분류할 수 있음
- 라벨은 Issue의 우선순위나 종류, 상태 등을 나타내는 데 사용
- 담당자(Assignees):
- Issue에 담당자를 할당하여 해당 문제를 처리할 책임자를 지정할 수 있음
- 댓글(Comment):
- Issue에 댓글을 달아 문제에 대한 의견을 나누거나 진행 상황을 공유할 수 있음
- 마일스톤(Milestones):
- Issue를 특정 마일 스톤과 연결하여 프로젝트 진행 상황을 관리할 수 있음
- 참조(References):
- Issue에서 다른 Issue, Pull Request, 커밋 등을 참조할 수 있음
- 연결 방법은 Cross-link를 사용하거나 키워드나 참조 구문을 사용하여 연결함
- 알림(Notifications):
- Issue의 변경 사항이나 새로운 댓글에 대한 알림을 받을 수 있음
- Projects:
- Trello와 유사한 프로젝트 보드 기능을 제공
- 프로젝트 보드에는 "To Do", "In Progress", "Done"와 같은 열로 구성되며, 직접 생성도 가능함
- 프로젝트 보드에서 Issue의 상태 변경, 담당자 할당, 마일스톤 연결 등의 작업 수행 가능
🚩Issue Template
.github/ISSUE_TEMPLATE 폴더에 마크다운 언어로 작성된 파일을 넣어두면 Issue를 등록할 때 해당 템플릿을 사용할 수 있습니다.
---
name: Bug Report Template
about: 버그 리포트 템플릿입니다.
title: ''
labels: 'Status: To Do, Priority: Medium, Type: Bugfix/Function, Type: Bugfix/UI'
assignees: ''
---
# 발생 일시
# 발생 위치
# 증상
# 재현 방법
# 스크린샷
