Skip to content

Commit 29a2dc5

Browse files
agung2001leibale
andauthored
update issue templates and add new documentation issue template (#2357)
* feat: update issue templates and add new documentation issue template * update templates * refine templates Co-authored-by: Leibale <me@leibale.com>
1 parent d77be81 commit 29a2dc5

File tree

5 files changed

+69
-22
lines changed

5 files changed

+69
-22
lines changed

.github/ISSUE_TEMPLATE/BUG-REPORT.yml

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
name: Bug Report
2+
description: Tell us about something that isn't working as expected
3+
labels: [Bug]
4+
body:
5+
- type: textarea
6+
id: description
7+
attributes:
8+
label: Description
9+
description: Please enter a detailed description of your issue. If possible, please provide example code to reproduce the issue.
10+
validations:
11+
required: true
12+
- type: input
13+
id: node-js-version
14+
attributes:
15+
label: Node.js Version
16+
description: Please enter your Node.js version `node --version`
17+
- type: input
18+
id: redis-server-version
19+
attributes:
20+
label: Redis Server Version
21+
description: Please enter your Redis server version ([`INFO server`](https://redis.io/commands/info/))
22+
- type: input
23+
id: node-redis-version
24+
attributes:
25+
label: Node Redis Version
26+
description: Please enter your node redis version `npm ls redis`
27+
- type: input
28+
id: platform
29+
attributes:
30+
label: Platform
31+
description: Please enter the platform you are using e.g. Linux, macOS, Windows
32+
- type: textarea
33+
id: logs
34+
attributes:
35+
label: Logs
36+
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
37+
render: bash
38+
validations:
39+
required: false
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
name: Documentation
2+
description: Any questions or issues relating to the project documentation.
3+
labels: [Documentation]
4+
body:
5+
- type: textarea
6+
id: description
7+
attributes:
8+
label: Description
9+
description: Ask your question or describe your issue here.
10+
validations:
11+
required: true
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
name: Feature Request
2+
description: Suggest an idea for this project
3+
labels: [Feature]
4+
body:
5+
- type: textarea
6+
id: motivation
7+
attributes:
8+
label: Motivation
9+
description: How would Node Redis users benefit from this feature?
10+
validations:
11+
required: true
12+
- type: textarea
13+
id: basic-code-example
14+
attributes:
15+
label: Basic Code Example
16+
description: Provide examples of how you imagine the API for this feature might be implemented. This will be automatically formatted into code, so no need for backticks.
17+
render: JavaScript
18+
validations:
19+
required: false

.github/ISSUE_TEMPLATE/bug-report.md

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

.github/ISSUE_TEMPLATE/feature-request.md

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

0 commit comments

Comments
 (0)