Skip to content

Commit dd4d137

Browse files
authored
feat: create issue templates
Bug report, feature request, and documentation templates
1 parent 657d507 commit dd4d137

File tree

3 files changed

+83
-0
lines changed

3 files changed

+83
-0
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

+46
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: bug, 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+
## Expected Behavior
16+
<!--- If you're describing a bug, tell us what should happen -->
17+
<!--- If you're suggesting a change/improvement, tell us how it should work -->
18+
19+
## Current Behavior
20+
<!--- If describing a bug, tell us what happens instead of the expected behavior -->
21+
<!--- If suggesting a change/improvement, explain the difference from current behavior -->
22+
23+
## Possible Solution
24+
<!--- Not obligatory, but suggest a fix/reason for the bug, -->
25+
<!--- or ideas how to implement the addition or change -->
26+
27+
## Steps to Reproduce (for bugs)
28+
<!--- Provide a link to a live example, or an unambiguous set of steps to -->
29+
<!--- reproduce this bug. Include code to reproduce, if relevant -->
30+
1.
31+
2.
32+
3.
33+
4.
34+
35+
## Environment
36+
37+
* **Powertools version used**:
38+
* **Packaging format (Layers, PyPi)**:
39+
* **AWS Lambda function runtime:**
40+
* **Debugging logs**
41+
42+
> [How to enable debug mode](https://awslabs.github.io/aws-lambda-powertools-python/#debug-mode)**
43+
44+
```python
45+
# paste logs here
46+
```
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
name: Documentation improvements
3+
about: Suggest a documentation update
4+
title: ''
5+
labels: documentation
6+
assignees: ''
7+
8+
---
9+
10+
**What were you initially searching for in the docs?**
11+
<!-- Please help us understand how you looked for information that was either not available or unclear -->
12+
13+
**Is this related to an existing part of the documentation? Please share a link**
14+
15+
**Describe how we could make it clearer**
16+
17+
**If you have a proposed update, please share it here**
+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: triage, feature-request
6+
assignees: ''
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->
12+
13+
**Describe the solution you'd like**
14+
<!-- A clear and concise description of what you want to happen. -->
15+
16+
**Describe alternatives you've considered**
17+
<!-- A clear and concise description of any alternative solutions or features you've considered. -->
18+
19+
**Additional context**
20+
<!-- Add any other context or screenshots about the feature request here. -->

0 commit comments

Comments
 (0)