Github 문서 템플릿

#Github 문서 템플릿

github에서 제공해주는 템플릿 기능이며, issue template, pull request template이 있습니다.

문서 템플릿을 만들어두면 양식이 통일이 되어 소통에 효율적이며, 문서 파악이 쉬워지고, 유지보수가 편리하다는 이점이 있습니다.

1. 이슈 템플릿 만들기

이슈 템플릿을 만드는 방법에는 두 가지 방법이 있습니다.

💡 github 사이트에서 GUI로 만들기

1. 이슈 템플릿을 만들 github의 레파지토리에 들어가서 Setting 탭으로 들어가서 Feature-issues-set up template 버튼을 누르기

2. add template:select를 클릭하면 버그 리포트, 기능관련 요청, 커스텀 템플릿을 만들기

• 참고하면 좋을 템플릿이 작성되어 있는 블로그

3. 이슈 템플릿을 모두 만들었다면, propose changes 버튼을 누르고, 변경사항 커밋하기

4. 이슈 탭에서 작성한 이슈 템플릿이 잘 작성되었는지 확인하기

💡 editor에서 만들기

1. root 폴더에서 .github 폴더를 만들기

1-1. 한 개의 issue template을 작성할 때에는 issue_template.md 파일을 작성하기

1-2.여러 개의 템플릿을 작성할 때에는 ISSUE_TEMPLATE 폴더를 만든 다음 템플릿 파일 작성하기

---
name: 템플릿 이름
about: 템플릿 설명
title: 제목 자동 기입
lables: 라벨 자동 등록
assignees: 담당자 자동 등록
---

<!-- 템플릿 양식 -->

2. PR 템플릿 만들기

editor에서 만들기

1. pull_request_template.md 작성하는 경로

• root 폴더 안 .github 폴더
• root 폴더에 작성
• docs 폴더 안에 작성

2. pull_request_template.md파일 만들고, 템플릿 작성하기

## 개요

<!---- 변경 사항 및 관련 이슈에 대해 간단하게 작성해주세요. 어떻게보다 무엇을 왜 수정했는지 설명해주세요. -->

<!---- Resolves: #(Isuue Number) -->

## PR 유형

어떤 변경 사항이 있나요?

- [ ] 새로운 기능 추가
- [ ] 버그 수정
- [ ] CSS 등 사용자 UI 디자인 변경
- [ ] 코드에 영향을 주지 않는 변경사항(오타 수정, 탭 사이즈 변경, 변수명 변경)
- [ ] 코드 리팩토링
- [ ] 주석 추가 및 수정
- [ ] 문서 수정
- [ ] 테스트 추가, 테스트 리팩토링
- [ ] 빌드 부분 혹은 패키지 매니저 수정
- [ ] 파일 혹은 폴더명 수정
- [ ] 파일 혹은 폴더 삭제

• PR 템플릿 출처