gitea Issue Template

팀/조직 내에서 이슈 관리시스템을 사용할 때 가장 피곤한 일이 작성할 때 모호한 내용을 입력하는 경우입니다. 이런 경우 다시 모여 협의하고, 정리하고 등등 짜증이 확 밀려옵니다.

 

그래서 입력시 일정한 형태로 작성해야 할 필요가 있습니다. 이럴 때 사용하는 것이 템플릿입니다.

설명서 : https://docs.gitea.com/usage/issue-pull-request-templates

Issue and Pull Request templates | Gitea Documentation

템플릿을 여러개 만드는 방법과 사용가능한 html type 설명을 볼 수 있습니다.

 

2개 방법으로 작성이 가능한데, md, yaml 파일 포맷으로 작성합니다. 입력이 익숙한 개발팀이라면 md 파일로 작성하는 것도 좋습니다. 업무협업을 위해 타부서/고객등에게 제공한다면 yaml 포맷을 사용하여 UI를 구성하는 것이 좋습니다.

 

반드시 master 브랜치에 .github(.gitea) 디렉터리를 생성합니다

 

 

첫째 방법은 issue_template.md를 아래와 같이 작성합니다. 

## Description
이슈에 대한 전체 설명을 작성합니다.


## 연관이슈
 * #13 : ~~~~~
 * #11 : ~~~~~

## To-Do 
 - [ ] 사용자 조회시 ~ 내용이 보이게 수정해야 함
 - [X] ~~~ 


## 기타사항
 * ~~~메모...

 

둘째 방법으로 UI를 구성하려면 .github(.gitea) 디렉터리에 issue_template.yml 파일을 만듭니다. 

 

파일내용입니다.

name: VOC Report
about: File a voc report
title: ""
body:
  - type: input
    id: customer
    attributes:
      label: 고객정보
      placeholder: ex 고객/고객사명, 이메일, 연락처등등
    validations:
      required: true

  - type: dropdown
    id: package
    attributes:
      label: 제품선택
      value: ""
      options:
        - 붕어빵
        - 잉어빵
    validations:
      required: true

  - type: textarea
    id: what-happened
    attributes:
      label: 현상/요구사항
      placeholder: 가능한 상세하게 작성해주세요, 이미지 붙여넣기, 파일 첨부등등...
      value: 
    validations:
      required: true

 

결과는 아래와 같습니다. 

 

md, yaml 두개가 존재하면 md가 우선합니다.

 

업무협업을 위해 타부서/고객에게 이것 저것 입력해라고 해도 지켜지지 않는게 현실입니다만, 이렇게 하면 좀 지켜지지 않을까요?