refactor: github issue & pull request template improvement [skip ci] (#294)
Diff
.github/ISSUE_TEMPLATE/bug_report.md | 28 +-------
.github/ISSUE_TEMPLATE/bug_report.yml | 118 ++++++++++++++++++++++++++++++-
.github/ISSUE_TEMPLATE/config.yml | 10 +++-
.github/ISSUE_TEMPLATE/feature_request.md | 19 +-----
.github/ISSUE_TEMPLATE/feature_request.yml | 96 ++++++++++++++++++++++++-
.github/PULL_REQUEST_TEMPLATE.md | 6 +-
6 files changed, 227 insertions(+), 50 deletions(-)
@@ -1,28 +0,0 @@
---
name: Bug report
about: Create a bug report to help us improve
title: ''
labels: ''
assignees: ''
---
**Describe the bug**
A clear and concise description of what the bug is.
**To Reproduce**
Steps to reproduce the behavior
**Expected behavior**
A clear and concise description of what you expected to happen.
**Logs/Screenshots**
If applicable, add logs or screenshots to help explain your problem.
**Environment and Specs**
- static-web-server: [e.g. v1.17.1]
- OS: [e.g. Linux 5.13.2, Macos 11.4, etc]
- Docker: [e.g. 20.10.7]
- Client: [e.g. Chrome 91.0.4472.114, Safari 14.1.1, curl, etc]
**Additional context**
Add any other context about the problem here if needed.
@@ -0,0 +1,118 @@
name: "Bug Report"
description: "Create a bug report to help us improve."
labels: ["bug", "v2"]
assignees:
- joseluisq
body:
- type: markdown
attributes:
value: |
**Thanks for taking the time to file a bug report! Please fill out this form as completely as possible.**
- type: checkboxes
id: search-duplicate
attributes:
label: Search for duplicate issues
options:
- label: I already searched, and this issue is not a duplicate.
required: true
- type: dropdown
id: issue-scope
attributes:
label: Issue scope
description: What is the scope of this issue?
options:
- BSD (E.g. FreeBSD, NetBSD, illumos)
- Linux (E.g. Arch Linux, Debian, Alpine, etc)
- macOS
- Windows / Windows Service
- Docker/Kubernetes
- Build target (binary)
- Libary (crate)
- Script installer
- Documentation
- Usability / User Experience
- CLI
- Configuration (e.g. TOML)
- Other
- type: textarea
id: describe-bug
attributes:
label: Describe the bug
description: A clear and concise description of what the bug is.
validations:
required: true
- type: textarea
id: how-reproduce
attributes:
label: How to reproduce it
description: Steps to reproduce the issue.
placeholder: |
1. First step...
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: textarea
id: complementary-info
attributes:
label: Complementary information
description: If applicable, add logs, screenshots or a video to help explain your problem.
validations:
required: false
- type: dropdown
id: build-target
attributes:
label: Build target used
description: Specify the SWS pre-compiled build (binary) target that you use.
options:
- aarch64-apple-darwin
- aarch64-linux-android
- aarch64-pc-windows-msvc
- aarch64-unknown-linux-gnu
- aarch64-unknown-linux-musl
- arm-unknown-linux-gnueabihf
- arm-unknown-linux-musleabihf
- armv7-unknown-linux-musleabihf
- i686-pc-windows-msvc
- i686-unknown-freebsd
- i686-unknown-linux-gnu
- i686-unknown-linux-musl
- powerpc64le-unknown-linux-gnu
- s390x-unknown-linux-gnu
- x86_64-apple-darwin
- x86_64-pc-windows-gnu
- x86_64-pc-windows-msvc
- x86_64-unknown-freebsd
- x86_64-unknown-illumos
- x86_64-unknown-linux-gnu
- x86_64-unknown-linux-musl
- x86_64-unknown-netbsd
- Built from source (specify below)
validations:
required: true
- type: textarea
id: environment-specs
attributes:
label: Environment and specs
description: Provide information about your environment and specs.
value: |
- [ ] **static-web-server:** [e.g. v1.24.1]
- [ ] **OS:** [e.g. Debian 12.2, Macos 14.1.2, Windows 11, etc]
- [ ] **Arch:** [e.g. x86_64 (64-bit), ARM (32-bit), ARM64 (64-bit), i686 (32-bit), etc]
- [ ] **Docker:** [e.g. 20.10.7]
- [ ] **Client:** [e.g. Chrome 91.0.4472.114, Firefox 119.0.1, curl, etc]
- [ ] Specify others
validations:
required: true
- type: textarea
id: additional-context
attributes:
label: Additional context
description: Add any other context information about the problem here if needed.
validations:
required: false
@@ -0,0 +1,10 @@
blank_issues_enabled: false
contact_links:
- name: Static Web Server - Website
url: https://static-web-server.net
about: |
Refer to official website for details about installation, usage, features and examples.
- name: Static Web Server - Community Support
url: https://github.com/orgs/static-web-server/discussions
about: |
Please use the discussions page if you have questions or need help.
@@ -1,19 +0,0 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: ''
assignees: ''
---
**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
**Describe the solution you'd like**
A clear and concise description of what you want to happen.
**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.
**Additional context**
Add any other context or screenshots about the feature request here if needed.
@@ -0,0 +1,96 @@
name: "Feature request or improvement"
description: "Suggest an idea for the project"
labels: ["enhancement", "help wanted", "v2"]
body:
- type: markdown
attributes:
value: |
**Thanks for taking the time to request a feature or improvement! Please fill out this form as completely as possible.**
- type: checkboxes
id: search-duplicate
attributes:
label: Search for duplicate feature request
options:
- label: I already searched, and this feature request or improvement is not a duplicate.
required: true
- type: dropdown
id: feature-scope
attributes:
label: Feature scope
description: What is the scope of this feature or improvement?
options:
- Completely new feature
- Improve existing functionality
- Target/OS/arch/platform
- Build target (binary)
- Libary/API (crate)
- Configuration (e.g. TOML) or CLI/env option
- Usability / User Experience
- Documentation
- Other (specify below)
- type: textarea
id: feature-related
attributes:
label: Feature request related to a problem
description: |
If the case, provide a clear and concise description of what the problem is. E.g. I'm always frustrated when [...]
validations:
required: false
- type: textarea
id: describe-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: describe-alternatives
attributes:
label: Describe alternatives you've considered
description: A clear and concise description of any alternative solutions or features you've considered.
validations:
required: true
- type: dropdown
id: build-target
attributes:
label: Build target
description: Specify the SWS target(s) involved in this feature request or if a new one.
options:
- All targets
- Only Unix targets
- Only Linux targets
- Only Unix/Linux targets
- Only macOS targets
- Only Window targets
- New target (specify below)
- aarch64-apple-darwin
- aarch64-linux-android
- aarch64-pc-windows-msvc
- aarch64-unknown-linux-gnu
- aarch64-unknown-linux-musl
- arm-unknown-linux-gnueabihf
- arm-unknown-linux-musleabihf
- armv7-unknown-linux-musleabihf
- i686-pc-windows-msvc
- i686-unknown-freebsd
- i686-unknown-linux-gnu
- i686-unknown-linux-musl
- powerpc64le-unknown-linux-gnu
- s390x-unknown-linux-gnu
- x86_64-apple-darwin
- x86_64-pc-windows-gnu
- x86_64-pc-windows-msvc
- x86_64-unknown-freebsd
- x86_64-unknown-illumos
- x86_64-unknown-linux-gnu
- x86_64-unknown-linux-musl
- x86_64-unknown-netbsd
validations:
required: true
- type: textarea
id: additional-context
attributes:
label: Additional context
description: Add any other context information about the problem here if needed.
validations:
required: false
@@ -1,7 +1,7 @@
## Description
## Related Issue
@@ -15,7 +15,7 @@
## How Has This Been Tested?
## Screenshots (if appropriate):
