📝 GitHub 문서 템플릿 작성하기

오픈소스 프로젝트에서 좋은 문서는 프로젝트의 신뢰도를 높이고,
외부 기여를 유도하며, 개발 흐름을 체계적으로 만든다.

GitHub는 문서 템플릿을 통해 이 과정을 쉽게 시작할 수 있도록 돕는다.

---

📄 문서 템플릿이란?

GitHub의 문서 템플릿은 이슈 생성, PR 생성, 또는 프로젝트 참여를 위한
가이드 문서를 미리 정의해 놓은 것이다.

대표적인 템플릿 문서는 다음과 같다:

• README.md: 프로젝트 개요, 설치 방법, 사용 방법 등을 설명
• CONTRIBUTING.md: 프로젝트 기여 방법 안내
• ISSUE_TEMPLATE: 이슈 작성 형식 지정
• PULL_REQUEST_TEMPLATE: PR 작성 형식 지정

---

📁 템플릿 디렉토리 구조 예시

.github/
├── ISSUE_TEMPLATE/
│   ├── bug_report.md
│   └── feature_request.md
├── PULL_REQUEST_TEMPLATE.md
├── CONTRIBUTING.md
└── CODE_OF_CONDUCT.md

---

🛠️ 이슈 템플릿 예시: bug_report.md

---
name: 🐛 버그 리포트
about: 버그 발생 시 제보해주세요
---

**버그 설명**
무엇이 잘못되었는지 명확하고 간결하게 설명해주세요.

**재현 방법**
1. 어떤 작업을 했는지 단계별로 설명해주세요
2. 어떤 결과가 나왔는지 작성해주세요

**예상되는 동작**
정상적인 동작이 무엇인지 설명해주세요

---

✅ 문서 템플릿의 장점

• 기여자가 필요한 정보를 빠르게 확인 가능
• 일관된 이슈 및 PR 양식 유지 가능
• 프로젝트 운영자와 커뮤니티 간 소통 효율 향상

---

📌 팁과 주의사항

• README.md에는 프로젝트 소개, 설치/실행 방법, 예제, 라이선스 포함
• 템플릿은 지나치게 복잡하지 않게 작성
• 명확한 언어와 예시로 작성자 가이드 제공

---

🔨 TIL

• GitHub 문서 템플릿을 통해 오픈소스 프로젝트에 기여하는 문화를 만들 수 있음을 배움
• 이슈/PR 템플릿을 통해 협업 효율을 높이고, 커뮤니케이션 비용을 줄일 수 있다는 점을 느꼈다