Skip to content

Commit 8969fb2

Browse files
authored
chore: Add issue templates (#735)
1 parent e81d9e1 commit 8969fb2

File tree

3 files changed

+94
-0
lines changed

3 files changed

+94
-0
lines changed

.github/ISSUE_TEMPLATE/bug-report.yml

+68
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
name: 🐛 Bug report
2+
description: Create a bug report
3+
body:
4+
- type: checkboxes
5+
attributes:
6+
label: Are you certain it's a bug?
7+
description: If you're uncertain, please report at https://github.com/serverless/serverless-python-requirements/discussions instead
8+
options:
9+
- label: Yes, it looks like a bug
10+
required: true
11+
- type: checkboxes
12+
attributes:
13+
label: Are you using the latest plugin release?
14+
description: Latest version can be checked at https://github.com/serverless/serverless-python-requirements/releases/latest
15+
options:
16+
- label: Yes, I'm using the latest plugin release
17+
required: true
18+
- type: checkboxes
19+
attributes:
20+
label: Is there an existing issue for this?
21+
description: Please search to see if an issue already exists
22+
options:
23+
- label: I have searched existing issues, it hasn't been reported yet
24+
required: true
25+
- type: textarea
26+
attributes:
27+
label: Issue description
28+
validations:
29+
required: true
30+
- type: textarea
31+
attributes:
32+
label: Service configuration (serverless.yml) content
33+
description: |
34+
Provide COMPLETE content of serverless.yml, ensuring that:
35+
• It consistently reproduces described issue
36+
• It's as minimal as possible
37+
• Ideally with no other plugins involved
38+
• Has sensitive parts masked out
39+
40+
If not applicable, fill with "N/A"
41+
render: yaml
42+
validations:
43+
required: true
44+
- type: input
45+
attributes:
46+
label: Command name and used flags
47+
description: |
48+
Full command name with used flags (If not applicable, fill with "N/A")
49+
placeholder: serverless <command name> [...flags]
50+
validations:
51+
required: true
52+
- type: textarea
53+
attributes:
54+
label: Command output
55+
description: |
56+
COMPLETE command output.
57+
58+
If not applicable, fill with "N/A"
59+
render: shell
60+
validations:
61+
required: true
62+
- type: textarea
63+
attributes:
64+
label: Environment information
65+
description: '"serverless --version" output + used version of the plugin'
66+
render: shell
67+
validations:
68+
required: true

.github/ISSUE_TEMPLATE/config.yml

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Question
4+
url: https://github.com/serverless/serverless-python-requirements/discussions
5+
about: Please ask and answer questions here
+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
name: 🎉 Feature request
2+
description: Suggest an idea
3+
body:
4+
- type: checkboxes
5+
attributes:
6+
label: Is there an existing issue for this?
7+
description: Please search to see if an issue already exists
8+
options:
9+
- label: I have searched existing issues, it hasn't been reported yet
10+
required: true
11+
- type: textarea
12+
attributes:
13+
label: Use case description
14+
description: Describe the use case that needs to be addressed
15+
validations:
16+
required: true
17+
- type: textarea
18+
attributes:
19+
label: Proposed solution (optional)
20+
description: |
21+
e.g. propose how the configuration and implementation of the new feature could look

0 commit comments

Comments
 (0)