(3D)Dev Deep Dive/Templates & Guides

[Template] GitHub Label Setting

ThreeLight 2023. 4. 23. 23:43
728x90

Github Label Setting은 Github 프로젝트에서 이슈와 풀 리퀘스트에 태그를 지정하여 작업을 분류하고 조직화하는 데 사용되는 기능입니다. 이를 사용하면 프로젝트 관리가 훨씬 수월해지며, 몇 가지 주요 이점이 있습니다.

  1. 이슈 및 풀 리퀘스트 분류
    • 레이블을 사용하면 이슈와 풀 리퀘스트를 효과적으로 분류할 수 있습니다.
    • 예를 들어, 버그, 기능 요청, 문서 개선 등과 같은 카테고리로 나눌 수 있습니다.
  2. 작업 우선순위 지정
    • 레이블을 이용해 작업의 우선순위를 표시할 수 있습니다.
    • 예를 들어, 긴급, 높음, 중간, 낮음 등의 우선순위를 나타내는 레이블을 만들 수 있습니다.
  3. 팀 협업 향상
    • 팀원들이 레이블을 통해 작업을 빠르게 파악할 수 있어 효율적인 협업이 가능합니다.
  4. 이슈 및 풀 리퀘스트 필터링
    • 레이블을 사용하면 특정 작업을 쉽게 찾고 추적할 수 있습니다.
    • Github에서는 레이블을 기반으로 필터링을 적용할 수 있어 관련 작업을 빠르게 찾을 수 있습니다.
  5. 프로젝트 관리 도구와의 통합
    • Github 레이블은 다른 프로젝트 관리 도구와 통합될 수 있어, 작업 관리를 보다 일관성 있게 수행할 수 있습니다.

Github 레이블 설정은 다음과 같이 만들 수 있습니다.

  1. 버그(Bug)
    • 소프트웨어의 오류나 문제를 나타내는 레이블입니다.
    • 일반적으로 빨간색으로 표시합니다.
  2. 기능 요청(Feature request)
    • 새로운 기능이나 개선 사항을 제안하는 레이블입니다.
    • 주로 녹색으로 표시합니다.
  3. 문서(Documentation)
    • 문서 관련 작업을 나타내는 레이블입니다.
    • 보통 파란색으로 표시합니다.
  4. 질문(Question)
    • 프로젝트에 대한 질문이나 도움 요청을 나타내는 레이블입니다.
    • 보통 노란색으로 표시합니다.
  5. 우선순위(Priority)
    • 긴급, 높음, 중간, 낮음 등의 작업 우선순위를 나타내는 레이블입니다.
    • 각각 다른 색상을 사용하여 시각적으로 구분할 수 있습니다.
    • 예를 들어, 긴급은 빨간색, 높음은 주황색, 중간은 노란색, 낮음은 초록색으로 표시할 수 있습니다.
  6. 상태(Status)
    • 작업 진행 상태를 나타내는 레이블입니다.
    • 예를 들어, 진행 중(In progress), 검토 중(Review), 완료(Done) 등의 레이블을 만들 수 있습니다.
  7. 개발 분야(Domain)
    • 프로젝트 내에서 관련 있는 개발 영역을 구분하는 레이블입니다.
    • 예를 들어, 백엔드(Backend), 프론트엔드(Frontend), 데이터베이스(Database) 등의 레이블을 만들 수 있습니다.

위 내용을 템플릿 적용을 위해 JSON 형식으로 바꾸면 다음과 같은 결과를 볼 수 있습니다

[
  {
    "name": "버그",
    "color": "FF0000",
    "description": "소프트웨어의 오류나 문제"
  },
  {
    "name": "기능 요청",
    "color": "00FF00",
    "description": "새로운 기능이나 개선 사항 제안"
  },
  {
    "name": "문서",
    "color": "0000FF",
    "description": "문서 관련 작업"
  },
  {
    "name": "질문",
    "color": "FFFF00",
    "description": "프로젝트에 대한 질문이나 도움 요청"
  },
  {
    "name": "긴급",
    "color": "FF0000",
    "description": "긴급한 작업 우선순위"
  },
  {
    "name": "높음",
    "color": "FFA500",
    "description": "높은 작업 우선순위"
  },
  {
    "name": "중간",
    "color": "FFFF00",
    "description": "중간 작업 우선순위"
  },
  {
    "name": "낮음",
    "color": "00FF00",
    "description": "낮은 작업 우선순위"
  },
  {
    "name": "진행 중",
    "color": "008B8B",
    "description": "작업 진행 상태"
  },
  {
    "name": "검토 중",
    "color": "1E90FF",
    "description": "검토가 필요한 작업 상태"
  },
  {
    "name": "완료",
    "color": "008000",
    "description": "작업이 완료된 상태"
  },
  {
    "name": "백엔드",
    "color": "A020F0",
    "description": "백엔드 개발 관련 작업"
  },
  {
    "name": "프론트엔드",
    "color": "FF69B4",
    "description": "프론트엔드 개발 관련 작업"
  },
  {
    "name": "데이터베이스",
    "color": "00008B",
    "description": "데이터베이스 개발 관련 작업"
  }
]

그렇다면 어떻게 적용해야하나요?

GitHub 프로젝트에 레이블을 적용하는 방법에는 두 가지가 있습니다

그 중 간단하게 GitHub Repository에서 직접 바꾸는 방법을 먼저 소개하겠습니다

  1. 먼저, 저장소(repository)의 메인 페이지로 이동하세요.
  2. 상단 메뉴에서 "Issues"를 클릭합니다. 만약 "Issues" 탭이 없다면, 저장소의 "Settings"로 이동하여 "Features" 섹션에서 "Issues" 기능을 활성화하십시오.
  3. "Issues" 페이지에서 오른쪽 상단에 있는 "Labels" 버튼을 클릭합니다.
  4. "New label" 버튼을 클릭하여 새 레이블을 만들거나, 기존 레이블을 수정하거나 삭제할 수 있습니다.

다른 방법으로는 위에서 작성한 label.json 파일을 사용하여 여러 레이블을 일괄 적용하는 방법입니다

이 방법의 장점은 방법을 알아두고 있다면 미리 생성해둔 템플릿을 원하는 Repository에 간단하게 적용시킬 수 있다는 부분이 있습니다

위에서 제공한 label.json 파일을 사용하여 여러 레이블을 일괄 적용하려면, 아래와 같은 방법을 사용할 수 있습니다.

  1. 원하는 경로에 labels.json 파일을 생성합니다.
  2. labels.json 파일에 레이블을 설정하며, 위에 미리 작성해 둔 코드와 같이 작성합니다
  3. 깃허브 액세스 토큰을 준비합니다.
    • 토큰 발급이 완료되면 준비 과정이 끝납니다.
  4.  labels.json 파일이 저장된 위치로 이동한 후, 아래 명령어를 입력하여 레이블을 업데이트합니다.
npx github-label-sync --access-token {본인의 token} --labels ./labels.json {라벨을 업데이트하고 싶은 본인의 레포지터리}

예시(임의의 토큰과 레포지토리명)

npx github-label-sync --access-token ghp_5Ys79l8dasljdklasjd --labels ./labels.json TMInstaller/good

위의 과정대로 진행하면 이슈와 풀 리퀘스트에 레이블이 추가되며, 이를 통해 작업을 더 쉽게 분류하고 관리할 수 있습니다.

End

728x90
저작자표시 비영리 변경금지