Skip to content

Commit 6388cac

Browse files
committed
Added issue templates
- this should help make triaging better when we have the info we need
1 parent 454f416 commit 6388cac

File tree

4 files changed

+130
-0
lines changed

4 files changed

+130
-0
lines changed

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
name: 🐛 Bug report
2+
description: Report a reproducible issue
3+
labels: ["bug"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
## Welcome 👋
9+
Thank you for taking the time to fill out a bug report 🙂
10+
11+
The more information you provide, the easier & quicker it is for us to diagnose the problem.
12+
13+
Please search the existing issues and recent releases to make sure your problem hasn't already been solved.
14+
- type: textarea
15+
id: summary
16+
attributes:
17+
label: Issue Summary
18+
description: Explain what's wrong
19+
validations:
20+
required: true
21+
- type: textarea
22+
id: reproduction
23+
attributes:
24+
label: Steps to Reproduce
25+
description: Also tell us, what did you expect to happen?
26+
placeholder: |
27+
1. This is the first step...
28+
2. This is the second step, etc.
29+
validations:
30+
required: true
31+
- type: input
32+
id: version
33+
attributes:
34+
label: Version
35+
description: What version of `node-sqlite3` are you using?
36+
validations:
37+
required: true
38+
- type: input
39+
id: node
40+
attributes:
41+
label: Node.js Version
42+
validations:
43+
required: true
44+
- type: input
45+
id: os
46+
attributes:
47+
label: How did you install the library?
48+
description: Provide details of your operating system and architecture
49+
validations:
50+
required: true

.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: 📖 API documentation
4+
url: https://github.com/TryGhost/node-sqlite3/wiki/API
5+
about: Documentation for the `node-sqlite3` API
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
name: ✨ Feature request
2+
description: Request a desired feature
3+
labels: ["feature request"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
## Welcome 👋
9+
Thank you for taking the time to fill out a feature request
10+
11+
The more information you provide, the easier it is for us to understand your use case.
12+
- type: textarea
13+
id: summary
14+
attributes:
15+
label: Summary
16+
description: Explain your use case. How would this improve your life?
17+
validations:
18+
required: true
19+
- type: textarea
20+
id: reproduction
21+
attributes:
22+
label: Proposed implementation
23+
description: Give an API proposal. How would the feature work?
24+
placeholder: |
25+
The Database class has a new function called...
26+
validations:
27+
required: true
Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
name: ⚙️ Installation problem
2+
description: Report an issue installing the library
3+
labels: ["install problem"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
## Welcome 👋
9+
Thank you for taking the time to fill out a report with installing 🙂
10+
11+
The more information you provide, the easier & quicker it is for us to diagnose the problem.
12+
13+
Please search the existing issues and recent releases to make sure your problem hasn't already been solved.
14+
- type: textarea
15+
id: summary
16+
attributes:
17+
label: Issue Summary
18+
description: Explain what's wrong
19+
validations:
20+
required: true
21+
- type: textarea
22+
id: logs
23+
attributes:
24+
label: Relevant logs or output
25+
placeholder: |
26+
Error when installing `sqlite3` due to...
27+
validations:
28+
required: true
29+
- type: input
30+
id: version
31+
attributes:
32+
label: Version
33+
description: What version of `node-sqlite3` are you using?
34+
validations:
35+
required: true
36+
- type: input
37+
id: node
38+
attributes:
39+
label: Node.js Version
40+
validations:
41+
required: true
42+
- type: input
43+
id: os
44+
attributes:
45+
label: How did you install the library?
46+
description: Provide details of your operating system and architecture
47+
validations:
48+
required: true

0 commit comments

Comments
 (0)