Skip to content

Commit

Permalink
Merge branch 'awslabs:develop' into docs/1067
Browse files Browse the repository at this point in the history
  • Loading branch information
Michael Brewer authored Apr 5, 2022
2 parents 9561173 + 0d12384 commit 21c2798
Show file tree
Hide file tree
Showing 6 changed files with 181 additions and 63 deletions.
46 changes: 0 additions & 46 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

85 changes: 85 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
name: Bug report
description: Report a reproducible bug to help us improve
title: "Bug: TITLE"
labels: ["bug", "triage"]
body:
- type: markdown
attributes:
value: |
Thank you for submitting a bug report. Please add as much information as possible to help us reproduce.
Please remove or anonymize any sensitive data your report might contain.
- type: textarea
id: expected_behaviour
attributes:
label: Expected Behaviour
description: Please share details on the behaviour you expected
validations:
required: true
- type: textarea
id: current_behaviour
attributes:
label: Current Behaviour
description: Please share details on the current issue
validations:
required: true
- type: textarea
id: code_snippet
attributes:
label: Code snippet
description: Please share a code snippet to help us reproduce the issue.
render: python
validations:
required: true
- type: textarea
id: solution
attributes:
label: Possible Solution
description: If known, please suggest a potential resolution
validations:
required: false
- type: textarea
id: steps
attributes:
label: Steps to Reproduce
description: Please share how we might be able to reproduce this issue
validations:
required: true
- type: input
id: version
attributes:
label: AWS Lambda Powertools for Python version
placeholder: "latest, 1.25.6"
value: latest
validations:
required: true
- type: dropdown
id: runtime
attributes:
label: AWS Lambda function runtime
options:
- label: "3.6"
- label: "3.7"
- label: "3.8"
- label: "3.9"
validations:
required: true
- type: dropdown
id: packaging
attributes:
label: Packaging format used
options:
- label: "Lambda Layers"
- label: "Serverless Application Repository (SAR) App"
- label: "PyPi"
multiple: true
validations:
required: true
- type: textarea
id: logs
attributes:
label: Debugging logs
description: If available, please share [debugging logs](https://awslabs.github.io/aws-lambda-powertools-python/#debug-mode)
render: python
validations:
required: false
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: Ask a question
url: https://github.com/awslabs/aws-lambda-powertools-python/discussions/new
about: Ask a general question about Lambda Powertools
17 changes: 0 additions & 17 deletions .github/ISSUE_TEMPLATE/documentation-improvements.md

This file was deleted.

45 changes: 45 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation_improvements.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
name: Documentation improvements
description: Suggest a documentation update to improve everyone's experience
title: "Docs: TITLE"
labels: ["documentation", "triage"]
body:
- type: markdown
attributes:
value: |
Thank you for helping us improve everyone's experience. We review documentation updates on a case by case basis.
- type: textarea
id: search_area
attributes:
label: What were you searching in the docs?
description: Please help us understand how you looked for information that was either unclear or not available
validations:
required: true
- type: input
id: area
attributes:
label: Is this related to an existing documentation section?
description: Please share a link, if applicable
validations:
required: false
- type: textarea
id: idea
attributes:
label: How can we improve?
description: Please share your thoughts on how we can improve this experience
render: markdown
validations:
required: true
- type: textarea
id: suggestion
attributes:
label: Got a suggestion in mind?
description: Please suggest a proposed update
validations:
required: false
- type: checkboxes
id: acknowledgment
attributes:
label: Acknowledgment
options:
- label: I understand the final update might be different from my proposed suggestion, or refused.
required: true
46 changes: 46 additions & 0 deletions .github/ISSUE_TEMPLATE/static_typing_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
---
name: Static typing mismatch report
about: Create a report to help us improve static typing definition
title: 'Static typing: '
labels: static_typing, triage
assignees: ''

---

<!--- Provide a general summary of the issue in the Title above -->
<!--- How has this issue affected you? What are you trying to accomplish? -->

**What were you trying to accomplish?**

## Static type checker's output and config

<!--- Share your preferred static type checker output and any related configuration to help us reproduce it -->

```python
# output
```

## Possible Solution
<!--- Not obligatory. Any ideas you might have to address this type definition -->

## Steps to Reproduce
<!--- Provide a link to a live example, or an unambiguous set of steps to -->
<!--- reproduce this typing report. Include code to reproduce, if relevant -->

**Code snippet**

```python
```

**Steps**

1.
2.
3.

## Environment

* **Powertools version used**:
* **Static typing checker name and version**:

> 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 comments on commit 21c2798

Please sign in to comment.