18-4 github 문서 템플릿
Github 문서 템플릿
github에서 제공해주는 템플릿 기능
issue template, pull request template 등
템플릿 만들기
-
.github폴더 만들기 (루트경로) -
해당 디렉토리에 다음과 같은 마크다운 형식의 파일을 생성 (대소문자 상관x)
- issue_template.md
- pull_request_template.md
이슈나, PR요청 작성시 자동으로 해당양식이 불러와집니다.
e.g.
test/.github/issue_template.md
## test
- [] list 1
- [] list 2위와같이 되어있는 경우 issue 작성시 해당 템플릿이 자동으로 적용됩니다.
.github 폴더 : 템플릿 외에도, 깃허브 액션이나, 배포, 작업, 깃허브 설정 파일 등이 들어오는 곳
템플릿 만들기2
다중 이슈 템플릿 만들기
GitHub > Settings > General > Features > Set up Template > Add Template
Github에서 위와같은 경로에서도 템플릿 추가가 가능합니다.
Add Template에서 Bug report, Feature request, Custom issue template 3가지 기본양식 제공
Setting
Features
Select
원하는대로 양식을 지정한뒤 propose changes를 클릭하여 등록합니다.
* 바로 issue 탭으로 이동 X
* commit changes도 눌러줘야합니다. -> .github 폴더와 md 파일이 생성됨.
기타
---
name: Test
about: desc
title: test
labels: '' // 라벨은 작성하려면 배열형식으로 [bug, feature]
assignees: '' // 양수인 작성하려면 배열형식으로 [your-github-username]
---
## test
- 여기부터 이슈 양식 시작
이슈템플릿의 abcdefg.md 양식을 위와같이 표 형태로 작성하면 자동으로
템플릿 이름이 name
설명이 desc
기본 제목은 test
라벨로 bug, feature
your-github-usernmae 이 할당됩니다.
--- : YAML 프론트매터 라고 읽음
이후로는 다른 프로젝트들의 이슈들을 참고해서 수정해나가면 됩니다.
