Skip to content

Commit f71a79f

Browse files
dreamorosiijemmy
andauthored
chore(governance): update issue templates to use forms (#1128)
* chore: update issue templates * Update .github/ISSUE_TEMPLATE/bug_report.yml Co-authored-by: ijemmy <[email protected]> * Update .github/ISSUE_TEMPLATE/documentation_improvements.yml Co-authored-by: ijemmy <[email protected]> * Update .github/ISSUE_TEMPLATE/maintenance.yml Co-authored-by: ijemmy <[email protected]> * Update .github/ISSUE_TEMPLATE/maintenance.yml Co-authored-by: ijemmy <[email protected]> * Update .github/ISSUE_TEMPLATE/rfc.yml Co-authored-by: ijemmy <[email protected]> * Update .github/ISSUE_TEMPLATE/support_powertools.yml Co-authored-by: ijemmy <[email protected]> * Update .github/ISSUE_TEMPLATE/feature_request.yml Co-authored-by: ijemmy <[email protected]> Co-authored-by: ijemmy <[email protected]>
1 parent 652b7f0 commit f71a79f

12 files changed

+475
-198
lines changed

Diff for: .github/ISSUE_TEMPLATE/BUG_REPORT.md

-51
This file was deleted.

Diff for: .github/ISSUE_TEMPLATE/DOC_IMPROVEMENT.md

-38
This file was deleted.

Diff for: .github/ISSUE_TEMPLATE/FEATURE_REQUEST.md

-37
This file was deleted.

Diff for: .github/ISSUE_TEMPLATE/RFC.md

-71
This file was deleted.

Diff for: .github/ISSUE_TEMPLATE/bug_report.yml

+89
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
name: Bug report
2+
description: Report a reproducible bug to help us improve
3+
title: "Bug: TITLE"
4+
labels: ["bug", "triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thank you for submitting a bug report. Before you start, make sure that [the bug hasn't been reported already](https://github.com/awslabs/aws-lambda-powertools-typescript/issues).
10+
11+
Please add as much information as possible to help us reproduce, and remove any potential sensitive data.
12+
- type: textarea
13+
id: expected_behaviour
14+
attributes:
15+
label: Expected Behaviour
16+
description: Please share details on the behaviour you expected
17+
validations:
18+
required: true
19+
- type: textarea
20+
id: current_behaviour
21+
attributes:
22+
label: Current Behaviour
23+
description: Please share details on the current issue
24+
validations:
25+
required: true
26+
- type: textarea
27+
id: code_snippet
28+
attributes:
29+
label: Code snippet
30+
description: Please share a code snippet to help us reproduce the issue
31+
render: JavaScript
32+
validations:
33+
required: true
34+
- type: textarea
35+
id: solution
36+
attributes:
37+
label: Possible Solution
38+
description: If known, please suggest a potential resolution
39+
validations:
40+
required: false
41+
- type: textarea
42+
id: steps
43+
attributes:
44+
label: Steps to Reproduce
45+
description: Please share how we might be able to reproduce this issue
46+
validations:
47+
required: true
48+
- type: input
49+
id: version
50+
attributes:
51+
label: AWS Lambda Powertools for TypeScript version
52+
placeholder: "latest, 1.3.0"
53+
value: latest
54+
validations:
55+
required: true
56+
- type: dropdown
57+
id: runtime
58+
attributes:
59+
label: AWS Lambda function runtime
60+
options:
61+
- 12.x
62+
- 14.x
63+
- 16.x
64+
validations:
65+
required: true
66+
- type: dropdown
67+
id: packaging
68+
attributes:
69+
label: Packaging format used
70+
options:
71+
- Lambda Layers
72+
- Npm
73+
multiple: true
74+
validations:
75+
required: true
76+
- type: textarea
77+
id: logs
78+
attributes:
79+
label: Debugging logs
80+
description: If available, please share [debugging logs](https://awslabs.github.io/aws-lambda-powertools-python/#debug-mode)
81+
render: Shell
82+
validations:
83+
required: false
84+
- type: markdown
85+
attributes:
86+
value: |
87+
---
88+
89+
**Disclaimer**: After creating an issue, please wait until it is triaged and confirmed by a maintainer before implementing it. This will reduce amount of rework and the chance that a pull request gets rejected.

Diff for: .github/ISSUE_TEMPLATE/config.yml

+5-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,5 @@
1-
blank_issues_enabled: false
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Ask a question
4+
url: https://github.com/awslabs/aws-lambda-powertools-typescript/discussions/new
5+
about: Ask a general question about Lambda Powertools
+51
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
name: Documentation improvements
2+
description: Suggest a documentation update to improve everyone's experience
3+
title: "Docs: TITLE"
4+
labels: ["documentation", "triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thank you for helping us improve everyone's experience. We review documentation updates on a case by case basis.
10+
- type: textarea
11+
id: search_area
12+
attributes:
13+
label: What were you searching in the docs?
14+
description: Please help us understand how you looked for information that was either unclear or not available
15+
validations:
16+
required: true
17+
- type: input
18+
id: area
19+
attributes:
20+
label: Is this related to an existing documentation section?
21+
description: Please share a link, if applicable
22+
validations:
23+
required: false
24+
- type: textarea
25+
id: idea
26+
attributes:
27+
label: How can we improve?
28+
description: Please share your thoughts on how we can improve this experience
29+
render: Markdown
30+
validations:
31+
required: true
32+
- type: textarea
33+
id: suggestion
34+
attributes:
35+
label: Got a suggestion in mind?
36+
description: Please suggest a proposed update
37+
validations:
38+
required: false
39+
- type: checkboxes
40+
id: acknowledgment
41+
attributes:
42+
label: Acknowledgment
43+
options:
44+
- label: I understand the final update might be different from my proposed suggestion, or refused.
45+
required: true
46+
- type: markdown
47+
attributes:
48+
value: |
49+
---
50+
51+
**Disclaimer**: After creating an issue, please wait until it is triaged and confirmed by a maintainer before implementing it. This will reduce amount of rework and the chance that a pull request gets rejected.

0 commit comments

Comments
 (0)