이게뭐약 이슈 생성 및 관리 정책

AS-IS

: 프로젝트를 다시 시작하면서 로컬 파일로 저장하던 문서를 깃허브 organization의 projects를 활용하여 깃허브 하나로 관리할 수 있도록 개선했었으나, 관리의 문제인지 뒤죽박죽 섞여있는 느낌이 강했다

: 그것외에도 정리되지 않은 느낌이 너무 강했다

 

- 프로젝트의 문제점

: 프로젝트 탭에 들어가면 최근에 본 순서대로 프로젝트들이 노출되는데, 조회한지 오래된 프로젝트는 숨겨져서 (프로젝트라는 메뉴로 한 번 더 들어가야한다) 보기가 힘든 문제가 있다

: 템플릿이 여간 불편한 것이 아니다

: 초반에는 열심히 관리하였지만, 나중가서는 뭔지모를 불편함 때문에 사용을 안하게 된다 (특히 급한 이슈를 처리할때)

 

- 칸반보드의 문제점

: 깃허브 프로젝트에서 지원하는 칸반보드는 아이템을 추가하면서 이슈를 생성할 수 도 있고, 기존에 생성된 이슈와 연결하여 편리하게 사용할 수 있다는 장점이 있지만, 아이템이 계속 쌓이는 형식이기 때문에 한 번에 이슈를 찾는 것이 불편하다

 

 

 

 

 

TO-BE

- 이슈와 문서의 분리

: 현재 이슈와 문서가 섞여있어 직관성이 떨어져 보인다

 

- 레포지터리 별로 이슈를 관리

: 본래 칸반보드에서 메인 서버 / 딥러닝 서버 / 인프라의 이슈를 한 눈에 보고자 했지만, 이슈가 난잡하게 섞이는 문제가 있을 뿐더러 오래된 이슈, 중요도가 낮은 이슈가 함께 보이기 때문에 불편함이 있다

: 때문에 레포지터리에 있는 이슈탭에서 이슈를 관리하기로 했다

 

- 이슈 등록 템플릿 작성

: 기능 / 버그에 대한 템플릿을 만들어서 각 레포지터리에서 사용할 수 있도록 공유

 

- 커밋 메시지 통일

: 이슈 번호를 커밋메시지에 포함시켜 해당 이슈와 관련된 커밋임을 표시

 

 

 

 

 

새로운 이슈 템플릿 생성

: 레포지터리 > Settings > Features > Issue에서 이슈 템플릿을 생성

: 본래 프로젝트의 Organization 단위에서 이슈 템플릿을 생성하여 모든 레포지터리에서 공용으로 사용하려고 했으나, 깃허브에서 지원을 하지 않아서 템플릿을 하나 만들고 레포지터리마다 추가하기로 하였다

 

- 기능 개발

: 새로 개발할 기능에 대한 필요성과 설계

 

- 기능 개선

: 기존에 있던 기능에 대한 문제 상황과 설계

 

- 버그

: 발생한 버그의 해결에 대한 설명과 설계

 

 

 

 

 

 

개발 플로우 및 브랜치 정책 수립

## 1. 개발 플로우
#### 1. 레포지터리에 이슈 등록
#### 2. "[이슈태그]-#이슈 번호-이슈 이름" 으로 브랜치 생성
  - [FEATURE]: 기능 개발 이슈
  - [FIX]: 기능 개선 이슈
  - [BUG]: 버그 수정 이슈
```
ex) 
[FEATURE]-#1-메인 서버 도커 도입
[FIX]-#2-로그 개선
[BUG]-#3-컨테이너 통신 안되는 문제
```
#### 3. 작업 후 커밋과 이슈를 연동 (커밋 메시지 형식 준수)
```
#이슈 번호 - 커밋 내용
- 커밋 상세 내용

ex)
#1 - 메인 서버 도커 컨테이너 적용
- Dockerfile 초안 작성
```
#### 4. 이슈 해결 후 이슈 close


## 2. 브랜치 정책
* main
  - 소스 코드를 종합하는 브랜치
* release
  - 배포하기 위한 형상
  - CI/CD가 연동되어 있으며, 반드시 안정화 된 형상으로 유지해야함
* 개발 브랜치
  - 기능 개발, 기능 개선, 버그 수정 등 이슈 처리를 위한 작업 브랜치
  - "[이슈태그]-#이슈 번호-이슈 이름" 형식의 명명 규칙을 가짐

 

 

 

 

느낀점

: 아무래도 회사를 다니고 사회 생활을 하다보니 온전히 사이드 프로젝트에 집중하기가 어렵다는 점을 간과했다는 것을 느꼈다. 그래서 기간에 연연하지 않고 꾸준히 개선하며 개발하는 것을 중점으로 이슈 템플릿과 개발 플로우를 설계했다

: 진작에 세세하게 신경을 써서 템플릿과 개발 플로우를 일찍이 도입했었다면 깔끔하게 프로젝트를 관리하고 누락된 이슈 없이 히스토리를 쌓으며 개발할 수 있었을텐데 늦게 이걸 해버려서 너무 아쉽다

 

- 계획

: 지금까지 작성하지 못한 이슈들을 모두 작성해서 히스토리를 살려놓도록 하자