Skip to content

Commit 596cdac

Browse files
machafermachafer
authored
chore(governance): update issue templates (#1062)
1 parent 53c07ff commit 596cdac

File tree

5 files changed

+178
-17
lines changed

5 files changed

+178
-17
lines changed

‎.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-java/discussions/new
5+
about: Ask a general question about Lambda Powertools

‎.github/ISSUE_TEMPLATE/documentation-improvements.md

-17
This file was deleted.

‎.github/ISSUE_TEMPLATE/documentation_improvements.yml

+50
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
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+
validations:
30+
required: true
31+
- type: textarea
32+
id: suggestion
33+
attributes:
34+
label: Got a suggestion in mind?
35+
description: Please suggest a proposed update
36+
validations:
37+
required: false
38+
- type: checkboxes
39+
id: acknowledgment
40+
attributes:
41+
label: Acknowledgment
42+
options:
43+
- label: I understand the final update might be different from my proposed suggestion, or refused.
44+
required: true
45+
- type: markdown
46+
attributes:
47+
value: |
48+
---
49+
50+
**Disclaimer**: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.

‎.github/ISSUE_TEMPLATE/maintenance.yml

+67
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
name: Maintenance
2+
description: Suggest an activity to help address tech debt, governance, and anything internal
3+
title: "Maintenance: TITLE"
4+
labels: ["internal", "triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thank you for taking the time to help us improve operational excellence.
10+
11+
*Future readers*: Please react with 👍 and your use case to help us understand customer demand.
12+
- type: textarea
13+
id: activity
14+
attributes:
15+
label: Summary
16+
description: Please provide an overview in one or two paragraphs
17+
validations:
18+
required: true
19+
- type: textarea
20+
id: importance
21+
attributes:
22+
label: Why is this needed?
23+
description: Please help us understand the value so we can prioritize it accordingly
24+
validations:
25+
required: true
26+
- type: dropdown
27+
id: area
28+
attributes:
29+
label: Which area does this relate to?
30+
multiple: true
31+
options:
32+
- Automation
33+
- Governance
34+
- Tests
35+
- Tracer
36+
- Logger
37+
- Metrics
38+
- Parameters
39+
- SQS Large Message Handling
40+
- SQS Batch Processing
41+
- Validation
42+
- Idempotency
43+
- Custom Resources
44+
- Serialization
45+
- Other
46+
- type: textarea
47+
id: suggestion
48+
attributes:
49+
label: Solution
50+
description: If available, please share what a good solution would look like
51+
validations:
52+
required: false
53+
- type: checkboxes
54+
id: acknowledgment
55+
attributes:
56+
label: Acknowledgment
57+
options:
58+
- label: This request meets [Lambda Powertools Tenets](https://awslabs.github.io/aws-lambda-powertools-java/#tenets)
59+
required: true
60+
- label: Should this be considered in other Lambda Powertools languages? i.e. [Python](https://github.com/awslabs/aws-lambda-powertools-python/), [TypeScript](https://github.com/awslabs/aws-lambda-powertools-typescript/)
61+
required: false
62+
- type: markdown
63+
attributes:
64+
value: |
65+
---
66+
67+
**Disclaimer**: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.

‎.github/ISSUE_TEMPLATE/share_your_work.yml

+56
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
name: I Made This (showcase your work)
2+
description: Share what you did with Powertools 💞💞. Blog post, workshops, presentation, sample apps, etc.
3+
title: "[I Made This]: <TITLE>"
4+
labels: ["community-content"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: Thank you for helping spread the word out on Powertools, truly!
9+
- type: input
10+
id: content
11+
attributes:
12+
label: Link to your material
13+
description: |
14+
Please share the original link to your material.
15+
16+
*Note: Short links will be expanded when added to Powertools documentation*
17+
validations:
18+
required: true
19+
- type: textarea
20+
id: description
21+
attributes:
22+
label: Description
23+
description: Describe in one paragraph what's in it for them (readers)
24+
validations:
25+
required: true
26+
- type: input
27+
id: author
28+
attributes:
29+
label: Preferred contact
30+
description: What's your preferred contact? We'll list it next to this content
31+
validations:
32+
required: true
33+
- type: input
34+
id: author-social
35+
attributes:
36+
label: (Optional) Social Network
37+
description: If different from preferred contact, what's your preferred contact for social interactions?
38+
validations:
39+
required: false
40+
- type: textarea
41+
id: notes
42+
attributes:
43+
label: (Optional) Additional notes
44+
description: |
45+
Any notes you might want to share with us related to this material.
46+
47+
*Note: These notes are explicitly to Powertools maintainers. It will not be added to the community resources page.*
48+
validations:
49+
required: false
50+
- type: checkboxes
51+
id: acknowledgment
52+
attributes:
53+
label: Acknowledgment
54+
options:
55+
- label: I understand this content may be removed from Powertools documentation if it doesn't conform with the [Code of Conduct](https://aws.github.io/code-of-conduct)
56+
required: true

0 commit comments

Comments
 (0)