summary

hodooAI gitlab의 목적과 구성 요소 및 기준에 대해 정의한 후
각 구성 요소의 작성 규칙 및 예시에 대해 설명하는 Wiki입니다

목적

gitlab은 hodooAI의 member들이 일을 효율적으로 하기 위한 관리 시스템입니다
각 member들은 gitlab을 통해 일을 관리하여 효율을 향상할 수 있습니다

구성 요소

gitlab은 일을 분류하기 위해 2가지 구성 요소를 활용합니다

• Group
• Label

Group

Group은 일 즉, 코드 작성을 관리하는 project를 분류하는 가장 큰 단위입니다 sub group, project등 하위 구성 요소를 가집니다 자세히 보기

목적

Group은 일을 분류하는 가장 큰 단위입니다

구성 요소와 기준

Topic 2개와 DOCS 1개, Team 2개로
아래와 같이 총 5개입니다

• Group

  • SR : super resolution 일들
  • VIS : vis 일들
  • DOCS : 모든 문서 관련 일들
  • PS : ps 팀 member 들이 전담해야하는 일들
  • ML : ml 팀 member 들이 전담해야하는 일들

하위 구성 요소(계층 구조)

Group - sub group - project 순으로
계층 구조를 가집니다

• SR ----- Group

  • face ----- sub group
  • web-client ----- project
  • web-server
  • web-demo
  • processor
  • app-client
  • …
  • animation
  • …

• VIS

  • …

• DOCS

  • gitlab
  • …

• PS

  • …

• ML

  • …

sub group

여러 project를 하나의 topic으로 묶어서 관리하기 위한 단위입니다

project

project는 1개의 repository 입니다

작성 규칙

1. 예시를 참고하여 project 이름을 정합니다
2. project를 생성합니다
3. project에 관련된 member를 추가합니다

작성 예시

face SR 의 web-client 에 대한 project 생성 예시 입니다

위 생성 순서는 아래와 같습니다

1. group 선택 -> SR
2. sub group 선택 -> face
3. project 이름 -> web-client

Label

정의

Label 은 project 에서 발생한 issue를 설명합니다
(issue는 일의 작은 단위 중 하나입니다)

Label은 이러한 issue에 대해 key와 value 를 활용하여 설명합니다

구성요소와 기준

Label 은 Priority, Status, Type 3가지 key와
각각의 key마다 기준을 따라 정한 value로 구성되어 있습니다
특정 value 의 경우 개수에 제한이 있습니다
(ex - Status : In Progress -> 진행 중인 issue이므로 1-2개)

• Label

  • Priority : issue의 우선 순위로 dead line을 기준으로 value를 정합니다
  • Status : issue의 상태로 현재 일의 진행 단계를 기준으로 value를 정합니다
  • Type : issue이 project에 미치는 영향으로 그 영향을 기준으로 value를 정합니다

Priority

issue의 우선 순위를 설명하기 위해 3가지 value를 가집니다

• Priority

  • Critical : 가장 먼저 해야할 일(2-3개)
  • Major : 이번주 내로 마무리 지어야 하는 일(2-3개)
  • Minor : 앞으로 진행해야 할 일(2-3개)

Status

issue의 상태를 설명하기 위해 4가지 value를 가집니다

• Status

  • Completed : 처리가 끝난 issue(ex - merge 된 코드)(개수 상관 없음)
  • In Progress : 진행 중인 issue(1인 1-2개)
  • Pending : 시작했다가 멈춘 issue(개수 제한 없음)
  • Review Needed : 마무리 된 업무 중 팀원들의 리뷰(확인, 피드백)가 필요한 issue(개수 제한 없음)

Type

issue의 영향을 설명하기 위해 4가지 value를 가집니다

• Type

  • Bug : Project가 의도한대로 작동하지 않도록 만드는 원인을 해결하는 issue
  • Enhancement : Project를 개선하는 issue
  • Maintenance : Project를 유지보수 하는 issue
  • Question : Project에 관한 질문

작성 규칙

project 생성 후, 해당 project에 대한 issue을 만들고,
해당 issue을 설명하기 위해 적합한 label을 붙입니다

1. project에 대한 issue을 만듭니다
2. issue의 deadline을 고려하여 Priority의 value를 정합니다
3. issue의 진행 상태를 고려하여 Status의 value를 정합니다
4. issue이 project에 어떤 영향을 미칠지 고려하여 Type의 value를 정합니다
5. issue을 설명하기 위해 각각의 value를 정하면 그와 일치하는 label을 선택합니다