mirror of
https://github.com/dalbodeule/hop-gate.git
synced 2025-12-09 05:15:44 +09:00
5388517767
- Added `DISCUSSION_TEMPLATE.md` for GitHub Discussions announcements. - Introduced `DISCUSSION_001_PROJECT_INTRODUCTION.md` as a draft for the project introduction, architecture, and roadmap. - Templates provide bilingual (Korean/English) guidance for consistency and accessibility.
119 lines
3.7 KiB
Markdown
119 lines
3.7 KiB
Markdown
# GitHub Discussions Announcement Template / GitHub Discussions 공지 템플릿
|
||
|
||
<!--
|
||
Use this template when creating an Announcement in GitHub Discussions.
|
||
Copy-paste and edit the content as needed.
|
||
GitHub currently does not support repository-based Discussion templates in .github.
|
||
GitHub Discussions에서 Announcement를 작성할 때 사용하는 템플릿입니다.
|
||
아래 내용을 복사해서 저장소의 Announcement에 붙여넣은 뒤 수정해서 사용하세요.
|
||
현재 .github 디렉터리를 통한 Discussion 템플릿 연동은 지원되지 않습니다.
|
||
-->
|
||
|
||
## Metadata / 메타데이터
|
||
|
||
- **Category / 카테고리**: `Announcements`
|
||
- **Status / 상태**: `Planned`, `In progress`, `Completed` (choose one) / (택1)
|
||
- **Related Issue(s) / 관련 이슈**: #ISSUE_ID
|
||
- **Related PR(s) / 관련 PR**: #PR_ID
|
||
- **Target version / 대상 버전**: e.g. `v0.2.0`
|
||
|
||
---
|
||
|
||
## Title / 제목
|
||
|
||
<!-- Short, user-facing title / 사용자 입장에서 이해하기 쉬운 짧은 제목 -->
|
||
|
||
<!--
|
||
EN: e.g. "Deprecation of legacy ACME endpoint"
|
||
KO: 예) "기존 ACME 엔드포인트 지원 종료 안내"
|
||
-->
|
||
|
||
## Summary / 개요
|
||
|
||
<!--
|
||
EN: 2–3 sentences describing what is changing and why it matters.
|
||
KO: 무엇이, 왜 변경되는지 2–3문장으로 요약해주세요.
|
||
-->
|
||
|
||
- What is changing? / 무엇이 변경되나요?
|
||
- Why are we changing it now? / 왜 지금 변경하나요?
|
||
- Who is affected? / 누가 영향을 받나요?
|
||
|
||
## Details / 상세 내용
|
||
|
||
### Motivation / 배경 및 목적
|
||
|
||
<!--
|
||
EN: Explain the background, problem, or motivation.
|
||
KO: 이 변경의 배경, 문제 의식, 목표를 설명해주세요.
|
||
-->
|
||
|
||
### What is changing / 변경 사항
|
||
|
||
<!--
|
||
EN: Describe the technical or behavioral changes in more detail.
|
||
KO: 기술적/동작 측면에서 어떤 변화가 있는지 자세히 적어주세요.
|
||
-->
|
||
|
||
- [ ] Behavior change / 동작 변화
|
||
- [ ] Configuration change / 설정 변경
|
||
- [ ] API change / API 변경
|
||
- [ ] Operational change (deployment, monitoring, etc.) / 운영 변경(배포, 모니터링 등)
|
||
|
||
### Timeline / 일정
|
||
|
||
<!--
|
||
EN: Include key dates (announcement, rollout, deprecation, removal).
|
||
KO: 공지, 롤아웃, 사용 중단, 제거 예정일 등 주요 일정을 적어주세요.
|
||
-->
|
||
|
||
- Announcement date / 공지 일자: `YYYY-MM-DD`
|
||
- Rollout start / 롤아웃 시작: `YYYY-MM-DD`
|
||
- Deprecation date / 사용 중단 예정: `YYYY-MM-DD`
|
||
- Removal date (if any) / 완전 제거 예정일(선택): `YYYY-MM-DD`
|
||
|
||
## Impact & Risks / 영향 및 리스크
|
||
|
||
<!--
|
||
EN: Describe who is affected, possible regressions, and risk level.
|
||
KO: 어떤 사용자가 영향을 받는지, 회귀 가능성과 리스크 수준을 설명해주세요.
|
||
-->
|
||
|
||
- Affected components / 영향을 받는 컴포넌트:
|
||
- Affected users / 영향을 받는 사용자 그룹:
|
||
- Risk level / 리스크 수준: `Low`, `Medium`, `High`
|
||
|
||
## Migration / Action items / 마이그레이션 및 필요한 조치
|
||
|
||
<!--
|
||
EN: Provide clear step-by-step instructions for users.
|
||
KO: 사용자가 따라 할 수 있는 단계별 가이드를 작성해주세요.
|
||
-->
|
||
|
||
1. Step 1 / 1단계
|
||
2. Step 2 / 2단계
|
||
3. Step 3 / 3단계
|
||
|
||
## How to give feedback / 피드백 방법
|
||
|
||
<!--
|
||
EN: Tell users where and how to give feedback (issue, discussion, etc.).
|
||
KO: 피드백을 어디에, 어떻게 남기면 되는지 안내해주세요.
|
||
-->
|
||
|
||
- Open an Issue: link / 이슈 생성 링크
|
||
- Comment under this Announcement / 이 공지에 댓글로 남기기
|
||
- Other channels (if any) / 기타 채널(있는 경우)
|
||
|
||
## FAQ (optional) / 자주 묻는 질문 (선택)
|
||
|
||
<!--
|
||
EN: Add Q&A entries here as they appear.
|
||
KO: 자주 나오는 질문과 답변을 여기에 모아주세요.
|
||
-->
|
||
|
||
- **Q:**
|
||
**A:**
|
||
|
||
- **Q:**
|
||
**A:** |