From 02153bbc05233eb051d4f76b2c9bc26cc1022b8b Mon Sep 17 00:00:00 2001 From: ohah Date: Fri, 7 Nov 2025 21:36:16 +0900 Subject: [PATCH] =?UTF-8?q?docs(.github):=20=EB=B2=84=EA=B7=B8=20=EB=A6=AC?= =?UTF-8?q?=ED=8F=AC=ED=8A=B8=20=EB=B0=8F=20=EA=B8=B0=EB=8A=A5=20=EC=9A=94?= =?UTF-8?q?=EC=B2=AD=20=EC=9D=B4=EC=8A=88=20=ED=85=9C=ED=94=8C=EB=A6=BF=20?= =?UTF-8?q?=EC=B6=94=EA=B0=80=20=EB=B0=8F=20=EC=82=AC=EC=9A=A9=20=EA=B0=80?= =?UTF-8?q?=EC=9D=B4=EB=93=9C=20=EC=9E=91=EC=84=B1?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/ISSUE_TEMPLATE/bug_report.yml | 125 +++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.yml | 102 +++++++++++++++++ docs/docs/dev/development.mdx | 37 ++++++ 3 files changed, 264 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..30dd188 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,125 @@ +name: 버그 리포트 +description: 버그를 발견하셨나요? 알려주세요! +title: "[버그] " +labels: ["bug"] +body: + - type: markdown + attributes: + value: | + 버그 리포트를 작성해주셔서 감사합니다! 아래 정보를 작성해주시면 문제를 빠르게 해결할 수 있습니다. + + - type: textarea + id: description + attributes: + label: 버그 설명 + description: 버그에 대한 간단한 설명을 작성해주세요. + placeholder: 예: JavaScript 코드 실행 시 예상과 다른 결과가 출력됩니다. + validations: + required: true + + - type: textarea + id: reproduction + attributes: + label: 재현 단계 + description: 버그를 재현하는 단계를 작성해주세요. + placeholder: | + 1. 앱을 실행합니다 + 2. 에디터에 다음 코드를 입력합니다: + console.log('Hello'); + 3. 실행 버튼을 클릭합니다 + 4. 오류가 발생합니다 + validations: + required: true + + - type: textarea + id: expected + attributes: + label: 예상 동작 + description: 정상적으로 동작했을 때 예상되는 결과를 작성해주세요. + placeholder: 예: 콘솔에 "Hello"가 출력되어야 합니다. + validations: + required: true + + - type: textarea + id: actual + attributes: + label: 실제 동작 + description: 실제로 발생한 동작을 작성해주세요. + placeholder: 예: 아무것도 출력되지 않습니다. + validations: + required: true + + - type: dropdown + id: os + attributes: + label: 운영체제 + description: 사용 중인 운영체제를 선택해주세요. + options: + - macOS + - Windows + - Linux + validations: + required: true + + - type: input + id: os_version + attributes: + label: 운영체제 버전 + description: 운영체제의 버전을 입력해주세요. (예: macOS 14.6, Windows 11, Ubuntu 24.04) + placeholder: 예: macOS 14.6.0 + validations: + required: false + + - type: input + id: app_version + attributes: + label: 앱 버전 + description: ExecuteJS 앱의 버전을 입력해주세요. (설정 > 정보에서 확인 가능) + placeholder: 예: 1.0.0 + validations: + required: false + + - type: textarea + id: code + attributes: + label: 관련 코드 + description: 버그와 관련된 JavaScript 코드가 있다면 공유해주세요. (선택사항) + placeholder: | + ```javascript + console.log('Hello World'); + ``` + render: markdown + validations: + required: false + + - type: textarea + id: logs + attributes: + label: 로그/에러 메시지 + description: 콘솔 로그나 에러 메시지가 있다면 공유해주세요. (선택사항) + placeholder: | + ``` + 에러 메시지를 여기에 붙여넣으세요 + ``` + render: markdown + validations: + required: false + + - type: textarea + id: screenshots + attributes: + label: 스크린샷 + description: 문제를 설명하는 스크린샷이 있다면 공유해주세요. (선택사항) + placeholder: 스크린샷을 드래그 앤 드롭하거나 붙여넣으세요. + validations: + required: false + + - type: textarea + id: additional + attributes: + label: 추가 정보 + description: 버그와 관련된 추가 정보나 컨텍스트가 있다면 작성해주세요. (선택사항) + placeholder: 예: 특정 조건에서만 발생하거나, 최근 업데이트 후 발생하기 시작했습니다. + validations: + required: false + diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..5d1168f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,102 @@ +name: 기능 요청 +description: 새로운 기능이나 개선 사항을 제안해주세요! +title: "[기능] " +labels: ["enhancement"] +body: + - type: markdown + attributes: + value: | + 기능 요청을 제안해주셔서 감사합니다! 아래 정보를 작성해주시면 더 나은 제품을 만드는 데 도움이 됩니다. + + - type: textarea + id: problem + attributes: + label: 문제점 또는 개선이 필요한 부분 + description: 이 기능이 해결하거나 개선할 문제점을 설명해주세요. + placeholder: 예: 현재 JavaScript 코드를 실행할 때 결과를 복사하는 기능이 없어서 불편합니다. + validations: + required: true + + - type: textarea + id: solution + attributes: + label: 제안하는 해결 방법 + description: 원하는 기능이나 개선 사항을 구체적으로 설명해주세요. + placeholder: 예: 실행 결과 옆에 복사 버튼을 추가하여 클릭 한 번으로 결과를 클립보드에 복사할 수 있도록 하고 싶습니다. + validations: + required: true + + - type: textarea + id: alternatives + attributes: + label: 대안 + description: 고려했던 다른 해결 방법이나 대안이 있다면 작성해주세요. (선택사항) + placeholder: 예: 키보드 단축키(Cmd+C)로 결과를 복사하는 방법도 고려했습니다. + validations: + required: false + + - type: dropdown + id: priority + attributes: + label: 우선순위 + description: 이 기능의 중요도를 선택해주세요. + options: + - 낮음 - 편의 기능이지만 없어도 괜찮음 + - 보통 - 유용하지만 급하지 않음 + - 높음 - 중요한 기능이지만 필수는 아님 + - 매우 높음 - 필수적이거나 핵심 기능 + validations: + required: false + + - type: checkboxes + id: areas + attributes: + label: 관련 영역 + description: 이 기능이 영향을 미치는 영역을 선택해주세요. (복수 선택 가능) + options: + - label: 프론트엔드 (UI/UX) + - label: 백엔드 (Rust/Tauri) + - label: JavaScript 런타임 + - label: 코드 에디터 + - label: 실행 결과 표시 + - label: 파일 관리 + - label: 설정/환경 + - label: 성능 + - label: 문서화 + - label: 기타 + validations: + required: false + + - type: textarea + id: use_cases + attributes: + label: 사용 사례 + description: 이 기능이 어떻게 사용될지 구체적인 시나리오를 작성해주세요. (선택사항) + placeholder: | + 예시: + 1. 사용자가 JavaScript 코드를 실행합니다 + 2. 실행 결과가 표시됩니다 + 3. 사용자가 복사 버튼을 클릭합니다 + 4. 결과가 클립보드에 복사됩니다 + render: markdown + validations: + required: false + + - type: textarea + id: mockups + attributes: + label: 목업/스크린샷 + description: UI 변경이 포함된 경우, 목업이나 스크린샷을 공유해주세요. (선택사항) + placeholder: 목업 이미지를 드래그 앤 드롭하거나 붙여넣으세요. + validations: + required: false + + - type: textarea + id: additional + attributes: + label: 추가 정보 + description: 기능 요청과 관련된 추가 정보나 참고 자료가 있다면 작성해주세요. (선택사항) + placeholder: 예: 유사한 기능을 제공하는 다른 도구의 예시나 참고할 만한 자료가 있습니다. + validations: + required: false + diff --git a/docs/docs/dev/development.mdx b/docs/docs/dev/development.mdx index c5db6d3..b114d49 100644 --- a/docs/docs/dev/development.mdx +++ b/docs/docs/dev/development.mdx @@ -94,6 +94,43 @@ pnpm tauri:build 4. 커밋 메시지를 명확하게 작성하세요. 5. Pull Request를 생성하세요. +### 이슈 템플릿 사용하기 + +ExecuteJS 프로젝트는 버그 리포트와 기능 요청을 위한 GitHub 이슈 템플릿을 제공합니다. 이슈를 생성할 때 적절한 템플릿을 선택하여 작성해주시면 더 빠르고 정확한 피드백을 제공할 수 있습니다. + +#### 버그 리포트 + +버그를 발견하셨다면 **"버그 리포트"** 템플릿을 사용해주세요. 다음 정보를 포함해주시면 문제를 빠르게 해결할 수 있습니다: + +- **버그 설명**: 버그에 대한 간단한 설명 +- **재현 단계**: 버그를 재현하는 단계별 방법 +- **예상 동작**: 정상적으로 동작했을 때 예상되는 결과 +- **실제 동작**: 실제로 발생한 동작 +- **환경 정보**: 운영체제, OS 버전, 앱 버전 +- **관련 코드**: 버그와 관련된 JavaScript 코드 (선택사항) +- **로그/에러 메시지**: 콘솔 로그나 에러 메시지 (선택사항) +- **스크린샷**: 문제를 설명하는 스크린샷 (선택사항) + +#### 기능 요청 + +새로운 기능이나 개선 사항을 제안하고 싶으시다면 **"기능 요청"** 템플릿을 사용해주세요. 다음 정보를 포함해주시면 더 나은 제품을 만드는 데 도움이 됩니다: + +- **문제점 또는 개선이 필요한 부분**: 이 기능이 해결하거나 개선할 문제점 +- **제안하는 해결 방법**: 원하는 기능이나 개선 사항에 대한 구체적인 설명 +- **대안**: 고려했던 다른 해결 방법 (선택사항) +- **우선순위**: 기능의 중요도 (낮음/보통/높음/매우 높음) +- **관련 영역**: 이 기능이 영향을 미치는 영역 (프론트엔드, 백엔드, JavaScript 런타임 등) +- **사용 사례**: 구체적인 사용 시나리오 (선택사항) +- **목업/스크린샷**: UI 변경이 포함된 경우 시각 자료 (선택사항) + +#### 이슈 생성 방법 + +1. GitHub 저장소의 [Issues](https://github.com/ohah/executeJS/issues) 페이지로 이동합니다. +2. **"New issue"** 버튼을 클릭합니다. +3. **"버그 리포트"** 또는 **"기능 요청"** 템플릿을 선택합니다. +4. 템플릿의 각 항목을 작성합니다. +5. 이슈를 제출합니다. + ### 커밋 컨벤션 ```