Skip to content

Commit a168a20

Browse files
mrkushalsmMossaka
andauthored
chore: add issue templates for bug, feature, and docs (#611)
Co-authored-by: Jiaxiao Zhou <duibao55328@gmail.com>
1 parent 5e4d4f2 commit a168a20

4 files changed

Lines changed: 101 additions & 0 deletions

File tree

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
name: 🐛 Bug Report
2+
description: Create a report to help us improve Wassette
3+
title: "[Bug]: "
4+
labels: ["bug"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to fill out this bug report!
10+
- type: textarea
11+
id: description
12+
attributes:
13+
label: Describe the Bug
14+
description: A clear and concise description of what the bug is.
15+
placeholder: I tried to load a python component but Wassette panicked...
16+
validations:
17+
required: true
18+
- type: textarea
19+
id: reproduce
20+
attributes:
21+
label: Steps to Reproduce
22+
description: Steps to reproduce the behavior.
23+
placeholder: |
24+
1. Run 'wassette run ...'
25+
2. Load component 'example'
26+
3. See error
27+
validations:
28+
required: true
29+
- type: input
30+
id: version
31+
attributes:
32+
label: Wassette Version
33+
description: What version of Wassette are you running? (or Commit ID)
34+
placeholder: v0.1.0 or e.g., 8f3b2a1
35+
- type: dropdown
36+
id: os
37+
attributes:
38+
label: Operating System
39+
description: What OS are you running on?
40+
options:
41+
- Windows
42+
- macOS
43+
- Linux
44+
- Other
45+
- type: textarea
46+
id: logs
47+
attributes:
48+
label: Relevant Log Output
49+
description: Please copy and paste any relevant log output or stack traces.
50+
render: shell

.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: GitHub Discussions
4+
url: https://github.com/microsoft/wassette/discussions
5+
about: Please ask and answer questions here.
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
name: 📚 Documentation Improvement
2+
description: Report missing or incorrect documentation
3+
title: "[Docs]: "
4+
labels: ["documentation"]
5+
body:
6+
- type: textarea
7+
id: description
8+
attributes:
9+
label: Description
10+
description: What part of the documentation is missing or incorrect?
11+
validations:
12+
required: true
13+
- type: input
14+
id: link
15+
attributes:
16+
label: Link to documentation
17+
description: URL of the page that needs improvement
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
name: 🚀 Feature Request
2+
description: Suggest an idea for this project
3+
title: "[Feature]: "
4+
labels: ["enhancement"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for suggesting a new feature!
10+
- type: textarea
11+
id: description
12+
attributes:
13+
label: Is your feature request related to a problem? Please describe.
14+
description: A clear and concise description of what the problem is.
15+
placeholder: I'm always frustrated when I can't find a specific tool...
16+
validations:
17+
required: true
18+
- type: textarea
19+
id: solution
20+
attributes:
21+
label: Describe the solution you'd like
22+
description: A clear and concise description of what you want to happen.
23+
validations:
24+
required: true
25+
- type: textarea
26+
id: alternatives
27+
attributes:
28+
label: Describe alternatives you've considered
29+
description: A clear and concise description of any alternative solutions or features you've considered.

0 commit comments

Comments
 (0)