Skip to content

Commit 21c2798

Browse files
author
Michael Brewer
authored
Merge branch 'awslabs:develop' into docs/1067
2 parents 9561173 + 0d12384 commit 21c2798

File tree

6 files changed

+181
-63
lines changed

6 files changed

+181
-63
lines changed

Diff for: ‎.github/ISSUE_TEMPLATE/bug_report.md

-46
This file was deleted.

Diff for: ‎.github/ISSUE_TEMPLATE/bug_report.yml

+85
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
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. Please add as much information as possible to help us reproduce.
10+
11+
Please remove or anonymize any sensitive data your report might contain.
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: python
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 Python version
52+
placeholder: "latest, 1.25.6"
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+
- label: "3.6"
62+
- label: "3.7"
63+
- label: "3.8"
64+
- label: "3.9"
65+
validations:
66+
required: true
67+
- type: dropdown
68+
id: packaging
69+
attributes:
70+
label: Packaging format used
71+
options:
72+
- label: "Lambda Layers"
73+
- label: "Serverless Application Repository (SAR) App"
74+
- label: "PyPi"
75+
multiple: true
76+
validations:
77+
required: true
78+
- type: textarea
79+
id: logs
80+
attributes:
81+
label: Debugging logs
82+
description: If available, please share [debugging logs](https://awslabs.github.io/aws-lambda-powertools-python/#debug-mode)
83+
render: python
84+
validations:
85+
required: false

Diff for: ‎.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: Ask a question
4+
url: https://github.com/awslabs/aws-lambda-powertools-python/discussions/new
5+
about: Ask a general question about Lambda Powertools

Diff for: ‎.github/ISSUE_TEMPLATE/documentation-improvements.md

-17
This file was deleted.

Diff for: ‎.github/ISSUE_TEMPLATE/documentation_improvements.yml

+45
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
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

Diff for: ‎.github/ISSUE_TEMPLATE/static_typing_report.md

+46
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
name: Static typing mismatch report
3+
about: Create a report to help us improve static typing definition
4+
title: 'Static typing: '
5+
labels: static_typing, triage
6+
assignees: ''
7+
8+
---
9+
10+
<!--- Provide a general summary of the issue in the Title above -->
11+
<!--- How has this issue affected you? What are you trying to accomplish? -->
12+
13+
**What were you trying to accomplish?**
14+
15+
## Static type checker's output and config
16+
17+
<!--- Share your preferred static type checker output and any related configuration to help us reproduce it -->
18+
19+
```python
20+
# output
21+
```
22+
23+
## Possible Solution
24+
<!--- Not obligatory. Any ideas you might have to address this type definition -->
25+
26+
## Steps to Reproduce
27+
<!--- Provide a link to a live example, or an unambiguous set of steps to -->
28+
<!--- reproduce this typing report. Include code to reproduce, if relevant -->
29+
30+
**Code snippet**
31+
32+
```python
33+
```
34+
35+
**Steps**
36+
37+
1.
38+
2.
39+
3.
40+
41+
## Environment
42+
43+
* **Powertools version used**:
44+
* **Static typing checker name and version**:
45+
46+
> Note: Lambda Powertools for Python uses [MyPy as the preferred static checker](https://github.com/awslabs/aws-lambda-powertools-python/blob/develop/mypy.ini).

0 commit comments

Comments
 (0)