Skip to content

Commit 99f2bca

Browse files
author
Michael Brewer
authored
Merge branch 'awslabs:develop' into docs/1064
2 parents 041af09 + f24332d commit 99f2bca

File tree

8 files changed

+240
-132
lines changed

8 files changed

+240
-132
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,7 @@ body:
66
- type: markdown
77
attributes:
88
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.
9+
Thank you for submitting a bug report. Please add as much information as possible to help us reproduce, and remove any potential sensitive data.
1210
- type: textarea
1311
id: expected_behaviour
1412
attributes:
@@ -27,7 +25,7 @@ body:
2725
id: code_snippet
2826
attributes:
2927
label: Code snippet
30-
description: Please share a code snippet to help us reproduce the issue.
28+
description: Please share a code snippet to help us reproduce the issue
3129
render: python
3230
validations:
3331
required: true
@@ -83,3 +81,9 @@ body:
8381
render: python
8482
validations:
8583
required: false
84+
- type: markdown
85+
attributes:
86+
value: |
87+
---
88+
89+
**Disclaimer**: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.

‎.github/ISSUE_TEMPLATE/documentation_improvements.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,3 +43,9 @@ body:
4343
options:
4444
- label: I understand the final update might be different from my proposed suggestion, or refused.
4545
required: true
46+
- type: markdown
47+
attributes:
48+
value: |
49+
---
50+
51+
**Disclaimer**: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.

‎.github/ISSUE_TEMPLATE/feature_request.md

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

‎.github/ISSUE_TEMPLATE/feature_request.yml

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
name: Feature request
2+
description: Suggest an idea for Lambda Powertools
3+
title: "Feature request: TITLE"
4+
labels: ["feature-request", "triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thank you for taking the time to suggest an idea to the Lambda Powertools project.
10+
11+
*Future readers*: Please react with 👍 and your use case to help us understand customer demand.
12+
- type: textarea
13+
id: problem
14+
attributes:
15+
label: Use case
16+
description: Please help us understand your use case or problem you're facing
17+
validations:
18+
required: true
19+
- type: textarea
20+
id: suggestion
21+
attributes:
22+
label: Solution/User Experience
23+
description: Please share what a good solution would look like to this use case
24+
validations:
25+
required: true
26+
- type: textarea
27+
id: alternatives
28+
attributes:
29+
label: Alternative solutions
30+
description: Please describe what alternative solutions to this use case, if any
31+
render: markdown
32+
validations:
33+
required: false
34+
- type: checkboxes
35+
id: acknowledgment
36+
attributes:
37+
label: Acknowledgment
38+
options:
39+
- label: This feature request meets [Lambda Powertools Tenets](https://awslabs.github.io/aws-lambda-powertools-python/latest/#tenets)
40+
required: true
41+
- label: Should this be considered in other Lambda Powertools languages? i.e. [Java](https://github.com/awslabs/aws-lambda-powertools-java/), [TypeScript](https://github.com/awslabs/aws-lambda-powertools-typescript/)
42+
required: false
43+
- type: markdown
44+
attributes:
45+
value: |
46+
---
47+
48+
**Disclaimer**: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.

‎.github/ISSUE_TEMPLATE/rfc.md

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

‎.github/ISSUE_TEMPLATE/rfc.yml

Lines changed: 109 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,109 @@
1+
name: Request for Comments (RFC)
2+
description: Feature design and detailed proposals
3+
title: "RFC: TITLE"
4+
labels: ["RFC", "triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thank you for submitting a RFC. Please add as many details as possible to help further enrich this design.
10+
- type: input
11+
id: relation
12+
attributes:
13+
label: Is this related to an existing feature request or issue?
14+
description: Please share a link, if applicable
15+
- type: dropdown
16+
id: area
17+
attributes:
18+
label: Which AWS Lambda Powertools utility does this relate to?
19+
options:
20+
- label: "Tracer"
21+
- label: "Logger"
22+
- label: "Metrics"
23+
- label: "Event Handler - REST API"
24+
- label: "Event Handler - GraphQL API"
25+
- label: "Middleware factory"
26+
- label: "Parameters"
27+
- label: "Batch processing"
28+
- label: "Typing"
29+
- label: "Validation"
30+
- label: "Event Source Data Classes"
31+
- label: "Parser"
32+
- label: "Idempotency"
33+
- label: "Feature flags"
34+
- label: "JMESPath functions"
35+
- label: "Other"
36+
validations:
37+
required: true
38+
- type: textarea
39+
id: summary
40+
attributes:
41+
label: Summary
42+
description: Please provide an overview in one or two paragraphs
43+
validations:
44+
required: true
45+
- type: textarea
46+
id: problem
47+
attributes:
48+
label: Use case
49+
description: Please share the use case and motivation behind this proposal
50+
validations:
51+
required: true
52+
- type: textarea
53+
id: proposal
54+
attributes:
55+
label: Proposal
56+
description: Please explain the design in detail, so anyone familiar with the project could implement it
57+
placeholder: What the user experience looks like before and after this design?
58+
validations:
59+
required: true
60+
- type: textarea
61+
id: scope
62+
attributes:
63+
label: Out of scope
64+
description: Please explain what should be considered out of scope in your proposal
65+
validations:
66+
required: true
67+
- type: textarea
68+
id: challenges
69+
attributes:
70+
label: Potential challenges
71+
description: Nothing is perfect. Please share what common challenges, edge cases, unresolved areas, and suggestions on how to mitigate them
72+
validations:
73+
required: true
74+
- type: textarea
75+
id: integrations
76+
attributes:
77+
label: Dependencies and Integrations
78+
description: If applicable, please share whether this feature has additional dependencies, and how it might integrate with other utilities available
79+
validations:
80+
required: false
81+
- type: textarea
82+
id: alternatives
83+
attributes:
84+
label: Alternative solutions
85+
description: Please describe what alternative solutions to this use case, if any
86+
render: markdown
87+
validations:
88+
required: false
89+
- type: checkboxes
90+
id: acknowledgment
91+
attributes:
92+
label: Acknowledgment
93+
options:
94+
- label: This feature request meets [Lambda Powertools Tenets](https://awslabs.github.io/aws-lambda-powertools-python/latest/#tenets)
95+
required: true
96+
- label: Should this be considered in other Lambda Powertools languages? i.e. [Java](https://github.com/awslabs/aws-lambda-powertools-java/), [TypeScript](https://github.com/awslabs/aws-lambda-powertools-typescript/)
97+
required: false
98+
- type: markdown
99+
attributes:
100+
value: |
101+
---
102+
103+
**Disclaimer**: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.
104+
105+
Metadata information for admin purposes, please leave them empty.
106+
107+
* RFC PR:
108+
* Approved by: ''
109+
* Reviewed by: ''

‎.github/ISSUE_TEMPLATE/static_typing.yml

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
name: Static typing mismatch report
2+
description: Report a static type mismatch caught by a static type checker
3+
title: "Static typing: TITLE"
4+
labels: ["static_typing", "triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thank you for submitting a static typing report. Please add as much information as possible to help us reproduce.
10+
11+
Our preferred static type checker is [Mypy](https://mypy.readthedocs.io/en/stable/) using the following [configuration](https://github.com/awslabs/aws-lambda-powertools-python/blob/develop/mypy.ini).
12+
- type: dropdown
13+
id: tool
14+
attributes:
15+
label: Static type checker used
16+
options:
17+
- label: "mypy (project's standard)"
18+
- label: "pyright/pylance"
19+
- label: "pyre"
20+
- label: "pytype"
21+
validations:
22+
required: true
23+
- type: dropdown
24+
id: runtime
25+
attributes:
26+
label: AWS Lambda function runtime
27+
options:
28+
- label: "3.6"
29+
- label: "3.7"
30+
- label: "3.8"
31+
- label: "3.9"
32+
validations:
33+
required: true
34+
- type: input
35+
id: version
36+
attributes:
37+
label: AWS Lambda Powertools for Python version
38+
placeholder: "latest, 1.25.6"
39+
value: latest
40+
validations:
41+
required: true
42+
- type: textarea
43+
id: output
44+
attributes:
45+
label: Static type checker info
46+
description: Please share your static type checker's output, its configuration, and how you typically run it
47+
validations:
48+
required: true
49+
- type: textarea
50+
id: code_snippet
51+
attributes:
52+
label: Code snippet
53+
description: Please share a code snippet to help us reproduce the issue
54+
render: python
55+
validations:
56+
required: true
57+
- type: textarea
58+
id: solution
59+
attributes:
60+
label: Possible Solution
61+
description: If known, please suggest a potential resolution
62+
validations:
63+
required: false
64+
- type: markdown
65+
attributes:
66+
value: |
67+
---
68+
69+
**Disclaimer**: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.

‎.github/ISSUE_TEMPLATE/static_typing_report.md

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

0 commit comments

Comments
 (0)