mirror of
https://github.com/dalbodeule/hop-gate.git
synced 2025-12-08 04:45:43 +09:00
c1ba29079c
- Refactored `DISCUSSION_TEMPLATE.md` to enhance clarity and structure. - Simplified sections and eliminated redundancy for better usability. - Improved bilingual (Korean/English) guidance for consistency.
102 lines
3.8 KiB
Markdown
102 lines
3.8 KiB
Markdown
# GitHub Discussion Template / GitHub Discussion 템플릿
|
||
|
||
<!--
|
||
This document describes what to include when you start a new GitHub Discussion.
|
||
It is not automatically linked by GitHub; copy the structure and adapt it as needed.
|
||
|
||
이 문서는 새로운 GitHub Discussion을 만들 때 어떤 내용을 포함하면 좋은지 설명합니다.
|
||
GitHub에 자동으로 연결되는 템플릿은 아니며, 여기 구조를 참고해서 자유롭게 작성하면 됩니다.
|
||
-->
|
||
|
||
## 1. Title / 제목
|
||
|
||
- Write a short, user-facing title that explains the topic.
|
||
사용자가 이해하기 쉬운 짧은 제목을 적습니다.
|
||
- Avoid internal-only abbreviations.
|
||
내부에서만 통하는 약어 사용은 피해주세요.
|
||
|
||
## 2. Type of discussion / 디스커션 유형
|
||
|
||
<!-- Choose one or more that best describe your discussion. / 가장 잘 맞는 유형을 하나 이상 선택하세요. -->
|
||
|
||
- Question / 질문
|
||
- Idea / RFC (proposal) / 아이디어 · RFC(제안)
|
||
- Announcement draft / 공지 초안
|
||
- Design discussion / 설계 논의
|
||
- Process / workflow / 프로세스 · 워크플로
|
||
|
||
## 3. Summary / 개요
|
||
|
||
<!--
|
||
In 2–3 sentences, describe what this discussion is about and what you want to decide.
|
||
이 디스커션이 무엇에 대한 것인지, 무엇을 결정하고 싶은지 2~3문장으로 요약합니다.
|
||
-->
|
||
|
||
## 4. Background & motivation / 배경 및 문제 의식
|
||
|
||
<!--
|
||
Explain the context, current behavior, and why it is not sufficient.
|
||
현재 상황(맥락)과 동작, 그리고 왜 충분하지 않은지 설명해주세요.
|
||
-->
|
||
|
||
- Current situation / 현재 상황:
|
||
- Problems or pain points / 문제점, 불편함:
|
||
- Who is affected? / 누가 영향을 받나요?:
|
||
|
||
## 5. Proposal or question details / 제안 또는 질문 상세
|
||
|
||
<!--
|
||
If you are proposing a change, describe the idea as concretely as possible.
|
||
If you are asking a question, describe what you have already tried.
|
||
변경을 제안한다면 가능한 한 구체적으로 설명해주세요.
|
||
질문이라면 이미 시도해 본 것들을 함께 적어주세요.
|
||
-->
|
||
|
||
- What do you propose or ask? / 무엇을 제안하거나, 무엇을 묻고 있나요?
|
||
- How would it work in practice? / 실제로는 어떻게 동작하길 바라나요?
|
||
- Example flows, API, or config (if any). / 예시 플로우, API, 설정 등이 있다면 적어주세요.
|
||
|
||
## 6. Alternatives & prior art / 대안 및 참고 사례
|
||
|
||
<!--
|
||
List alternative options you have considered and why you chose this direction.
|
||
비슷한 다른 옵션들을 나열하고, 왜 이 방향을 선택했는지 설명해주세요.
|
||
-->
|
||
|
||
- Alternatives you considered / 고려했던 대안:
|
||
- Pros & cons / 장단점:
|
||
- Related tools, standards, or projects / 관련 도구, 표준, 프로젝트:
|
||
|
||
## 7. Impact / 영향 범위
|
||
|
||
<!--
|
||
Explain which parts of the system and which users would be affected.
|
||
시스템의 어떤 부분과 어떤 사용자가 영향을 받는지 설명해주세요.
|
||
-->
|
||
|
||
- API / Public surface / API 및 외부 공개 인터페이스:
|
||
- Configuration & deployment / 설정 및 배포:
|
||
- Security & privacy / 보안 및 프라이버시:
|
||
- Performance & reliability / 성능 및 안정성:
|
||
- Developer experience / 운영 및 개발자 경험(DX):
|
||
|
||
## 8. Open questions / 열린 질문
|
||
|
||
<!--
|
||
List questions you specifically want feedback on.
|
||
피드백을 받고 싶은 구체적인 질문들을 적어주세요.
|
||
-->
|
||
|
||
- Question 1:
|
||
- Question 2:
|
||
|
||
## 9. Proposed next steps / 다음 단계 제안
|
||
|
||
<!--
|
||
Suggest what should happen after this discussion (e.g. PoC, spec, PR).
|
||
이 디스커션 이후 어떤 다음 단계가 필요할지 제안해주세요 (예: PoC, 스펙 문서, PR 등).
|
||
-->
|
||
|
||
- Who will drive this forward? / 누가 이 작업을 주도하나요?
|
||
- Expected timeline (rough) / 대략적인 일정:
|
||
- Needed input or reviewers / 필요한 인풋·리뷰어: |