Skip to content

Commit 3f94365

Browse files
bjohansebasbjohansebas
committed
feat: add new issue templates for bug reports, feature requests, documentation issues, and questions
Signed-off-by: Sebastian Beltran <bjohansebas@gmail.com>
1 parent 573cb2c commit 3f94365

10 files changed

Lines changed: 182 additions & 92 deletions

File tree

‎.github/ISSUE_TEMPLATE/1-bug_report.yml‎

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
name: 🐛 Bug Report
2+
title: '🐛 Bug: <short description of the bug>'
3+
about: Do you believe you have found a bug?
4+
labels:
5+
- 'require-triage'
6+
type: Bug
7+
8+
body:
9+
- type: markdown
10+
attributes:
11+
value: |
12+
Thank you for reporting a bug! Please fill out the following sections to help us understand the issue.
13+
14+
- type: checkboxes
15+
attributes:
16+
description: If any of these required steps are missed, we might not be able to review your issue.
17+
label: Bug Report Checklist
18+
options:
19+
- label: I have read and agree to Express's [Code of Conduct](https://github.com/expressjs/.github/blob/master/CODE_OF_CONDUCT.md)
20+
required: true
21+
- label: I have searched for related issues but none matched my issue.
22+
required: true
23+
24+
- type: input
25+
attributes:
26+
label: Version
27+
description: |
28+
To check the installed version, you can use the following command: `npm ls name-of-package name-of-othe-package`
29+
validations:
30+
required: true
31+
32+
- type: textarea
33+
attributes:
34+
label: Platform
35+
render: text
36+
description: |
37+
UNIX: output of `uname -a`
38+
Windows: output of `"$([Environment]::OSVersion.VersionString) $(('x86', 'x64')[[Environment]::Is64BitOperatingSystem])"` in PowerShell console
39+
40+
- type: input
41+
attributes:
42+
label: Node.js version
43+
description: |
44+
Output of `node -v`.
45+
46+
- type: textarea
47+
attributes:
48+
label: What is the current behavior?
49+
description: |
50+
Please describe the current behavior of the application, including any error messages or unexpected results.
51+
validations:
52+
required: true
53+
54+
- type: textarea
55+
labels: Minimal, Reproducible Example
56+
attributes:
57+
label: What steps will reproduce the bug?
58+
description: |
59+
Please provide detailed steps to reproduce the problem.
60+
61+
To help us understand and fix the issue efficiently, please create a [MCVE](https://stackoverflow.com/help/mcve).
62+
validations:
63+
required: true

‎.github/ISSUE_TEMPLATE/1question.md‎

Lines changed: 0 additions & 16 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/2-feature_request.yml‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
name: 🚀 Feature Request
2+
title: '🚀 feature: <short description of the feature>'
3+
about: Do you want to make a feature request?
4+
type: Feature
5+
labels:
6+
- "ideas"
7+
- "require-triage"
8+
9+
body:
10+
- type: markdown
11+
attributes:
12+
value: |
13+
Thank you for submitting a feature request! Please fill out the following sections to help us understand the request.
14+
- type: checkboxes
15+
attributes:
16+
label: Feature Request Checklist
17+
description: If any of these required steps are missed, we might not be able to review your issue.
18+
options:
19+
- label: I have read and agree to Express's [Code of Conduct](https://github.com/expressjs/.github/blob/master/CODE_OF_CONDUCT.md)
20+
required: true
21+
- label: I have searched for related issues but none matched my issue.
22+
required: true
23+
- type: textarea
24+
attributes:
25+
description: What is the feature gap or problem you'd like to address?
26+
label: Overview
27+
validations:
28+
required: true
29+
- type: textarea
30+
attribute:
31+
description: |
32+
label: How should this be implemented in your opinion?
33+
- type: textarea
34+
attributes:
35+
description: Any additional info you'd like to provide.
36+
label: Additional Info

‎.github/ISSUE_TEMPLATE/2bug_report.md‎

Lines changed: 0 additions & 41 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/3-documentation.yml‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
name: 📝 Documentation Issue
2+
description: Report a possible issue in the documentation
3+
title: '📝 docs: <short description of the documentation issue>'
4+
labels:
5+
- "docs"
6+
- "require-triage"
7+
8+
body:
9+
- type: markdown
10+
attributes:
11+
value: |
12+
Thank you for submitting this issue! We'll try to triage it ASAP!
13+
14+
- type: checkboxes
15+
attributes:
16+
label: Documentation Issue Checklist
17+
description: If any of these required steps are missed, we might not be able to review your issue.
18+
options:
19+
- label: I have read and agree to Express's [Code of Conduct](https://github.com/expressjs/.github/blob/master/CODE_OF_CONDUCT.md)
20+
required: true
21+
- label: I have searched for related issues but none matched my issue.
22+
required: true
23+
24+
- type: textarea
25+
id: description
26+
attributes:
27+
label: Description
28+
description: Please provide a description of the issue
29+
validations:
30+
required: true
31+
32+
- type: textarea
33+
id: expectations
34+
attributes:
35+
label: Expectations
36+
description: Describe the expected behavior
37+
validations:
38+
required: true

‎.github/ISSUE_TEMPLATE/3feature_request.md‎

Lines changed: 0 additions & 13 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/4-question.yml‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
name: ❓ Question
2+
about: Seeking help or have a question about usage?
3+
title: '❓ question: <short description of the question>'
4+
labels:
5+
- "question"
6+
- "require-triage"
7+
8+
body:
9+
- type: markdown
10+
attributes:
11+
value: |
12+
**Thank you for your question!**
13+
To help us better understand and assist you, please fill out the following sections with the relevant details.
14+
15+
Please note that we can't debug your entire application for you, but we're happy to help answer specific questions.
16+
17+
You can also connect with the community in the OpenJS Slack workspace:
18+
19+
* [Join Slack](https://slack-invite.openjsf.org/)
20+
* [#express channel](https://openjs-foundation.slack.com/archives/C02QB1731FH)
21+
22+
23+
- type: checkboxes
24+
attributes:
25+
label: Question Checklist
26+
description: If any of these required steps are missed, we might not be able to review your issue.
27+
options:
28+
- label: I have read and agree to Express's [Code of Conduct](https://github.com/expressjs/.github/blob/master/CODE_OF_CONDUCT.md)
29+
required: true
30+
- label: I have searched for related issues but none matched my issue.
31+
required: true
32+
33+
- type: textarea
34+
attributes:
35+
label: Question
36+
description: |
37+
Please provide a clear and concise description of your question or the issue you're facing.
38+
Include any relevant code snippets, error messages, or context that will help us understand your question better.
39+
validations:
40+
required: true

‎.github/ISSUE_TEMPLATE/4documentation.yml‎

Lines changed: 0 additions & 22 deletions
This file was deleted.

.github/ISSUE_TEMPLATE/5other.md renamed to .github/ISSUE_TEMPLATE/5-other.md

File renamed without changes.

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: 🌐 Website issues
4+
url: https://github.com/expressjs/expressjs.com/issues/new/choose
5+
about: For website issues.

0 commit comments

Comments
 (0)