From 1337496dadae4886c1bd722a8861f2e3e8b8191a Mon Sep 17 00:00:00 2001 From: "kotaro.higuchi" <33714346+pycabbage@users.noreply.github.com> Date: Mon, 23 Dec 2024 18:07:33 +0900 Subject: [PATCH] Add ISSUE_TEMPLATE Fixes #34 Add issue templates for bug reports and feature requests. * **README.md** - Add a section on how to use the issue templates. - Provide links to the bug report and feature request templates. * **.github/ISSUE_TEMPLATE/bug_report.md** - Add a template for reporting bugs. - Include sections for description, steps to reproduce, expected behavior, and screenshots. * **.github/ISSUE_TEMPLATE/feature_request.md** - Add a template for requesting features. - Include sections for description, proposed solution, and alternatives considered. --- For more details, open the [Copilot Workspace session](https://copilot-workspace.githubnext.com/libxmlwasm/libxml.wasm/issues/34?shareId=XXXX-XXXX-XXXX-XXXX). --- .github/ISSUE_TEMPLATE/bug_report.md | 38 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 17 ++++++++++ README.md | 7 +++++ 3 files changed, 62 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..f3d5c41 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,38 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: bug +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Desktop (please complete the following information):** + - OS: [e.g. iOS] + - Browser [e.g. chrome, safari] + - Version [e.g. 22] + +**Smartphone (please complete the following information):** + - Device: [e.g. iPhone6] + - OS: [e.g. iOS8.1] + - Browser [e.g. stock browser, safari] + - Version [e.g. 22] + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..adcaa21 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,17 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: enhancement +assignees: '' + +--- + +**Description** +A clear and concise description of what the feature is. + +**Proposed Solution** +Describe the solution you'd like. + +**Alternatives Considered** +Describe any alternative solutions or features you've considered. diff --git a/README.md b/README.md index 1ad9663..7ddf7f2 100644 --- a/README.md +++ b/README.md @@ -47,3 +47,10 @@ console.log(h1.name) // "h1" console.log(h1.content) // "Hello world" console.log(h1.attr.class) // "title" ``` + +## Issue Templates + +We have provided issue templates to help you report bugs and request features more effectively. Please use the appropriate template when creating an issue: + +- [Bug Report](.github/ISSUE_TEMPLATE/bug_report.md) +- [Feature Request](.github/ISSUE_TEMPLATE/feature_request.md)