From ae1ede93102c9ace344b7bcb6b756b79ff5cd7a6 Mon Sep 17 00:00:00 2001 From: Katsuyuki Karasawa <4ranci0ne@gmail.com> Date: Sun, 3 Aug 2025 22:03:17 +0900 Subject: [PATCH] Add issue and pull request template (#578) * feat: add issue templates for bug reports, feature requests, and custom issues * feat: add pull request template for better contribution guidelines --- .github/ISSUE_TEMPLATE/01-bug_report.yml | 59 +++++++++++++++++++ .github/ISSUE_TEMPLATE/02-feature_request.yml | 41 +++++++++++++ .github/ISSUE_TEMPLATE/03-custom_issue.yml | 11 ++++ .github/pull_request_template.md | 37 ++++++++++++ 4 files changed, 148 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/01-bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/02-feature_request.yml create mode 100644 .github/ISSUE_TEMPLATE/03-custom_issue.yml create mode 100644 .github/pull_request_template.md diff --git a/.github/ISSUE_TEMPLATE/01-bug_report.yml b/.github/ISSUE_TEMPLATE/01-bug_report.yml new file mode 100644 index 0000000..5be1149 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/01-bug_report.yml @@ -0,0 +1,59 @@ +name: Bug Report +description: Create a report to help us improve +title: "[Bug]: " +labels: ["bug"] +assignees: + - L4Ph + - saicaca +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! + - type: textarea + id: bug-description + attributes: + label: Describe the bug + description: A clear and concise description of what the bug is. + validations: + required: true + - type: textarea + id: to-reproduce + attributes: + label: To Reproduce + description: Steps to reproduce the behavior. + placeholder: | + 1. Go to '...' + 2. Click on '....' + 3. Scroll down to '....' + 4. See error + validations: + required: true + - type: textarea + id: expected-behavior + attributes: + label: Expected behavior + description: A clear and concise description of what you expected to happen. + validations: + required: true + - type: dropdown + id: os + attributes: + label: OS + multiple: true + options: + - Windows + - macOS + - Linux + - Android + - iOS + - type: input + id: browser + attributes: + label: Browser + placeholder: e.g. chrome, safari + - type: textarea + id: additional-context + attributes: + label: Additional context + description: Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/02-feature_request.yml b/.github/ISSUE_TEMPLATE/02-feature_request.yml new file mode 100644 index 0000000..9c657f1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/02-feature_request.yml @@ -0,0 +1,41 @@ +name: Feature Request +description: Suggest an idea for this project +title: "[Feature]: " +labels: ["enhancement"] +assignees: + - saicaca +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this feature request! + - type: textarea + id: related-problem + attributes: + label: Is your feature request related to a problem? + description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + validations: + required: true + - type: textarea + id: solution + attributes: + label: Describe the solution you'd like + description: A clear and concise description of what you want to happen. + validations: + required: true + - type: textarea + id: alternatives + attributes: + label: Describe alternatives you've considered + description: A clear and concise description of any alternative solutions or features you've considered. + - type: textarea + id: additional-context + attributes: + label: Additional context + description: Add any other context or screenshots about the feature request here. + - type: markdown + attributes: + value: | + **Disclaimer** + + Please note that this feature request is at the discretion of the repository owner, @saicaca, and its implementation is not guaranteed. diff --git a/.github/ISSUE_TEMPLATE/03-custom_issue.yml b/.github/ISSUE_TEMPLATE/03-custom_issue.yml new file mode 100644 index 0000000..945b721 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/03-custom_issue.yml @@ -0,0 +1,11 @@ +name: Custom Issue +description: Describe your issue here. +title: "[Other]: " +body: + - type: textarea + id: issue-description + attributes: + label: Issue Description + description: Please describe your issue. + validations: + required: true diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..1f41d43 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,37 @@ +## Type of change + +- [ ] Bug fix (a non-breaking change that fixes an issue) +- [ ] New feature (a non-breaking change that adds functionality) +- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) +- [ ] Other (please describe): + +## Checklist + +- [ ] I have read the [**CONTRIBUTING**](https://github.com/saicaca/fuwari/blob/main/CONTRIBUTING.md) document. +- [ ] I have checked to ensure that this Pull Request is not for personal changes. +- [ ] I have performed a self-review of my own code. +- [ ] My changes generate no new warnings. + +## Related Issue + + + + +## Changes + + + + +## How To Test + + + + +## Screenshots (if applicable) + + + + +## Additional Notes + +