Skip to content

Commit

Permalink
chore(governance): update issue templates to use forms (#1128)
Browse files Browse the repository at this point in the history
* chore: update issue templates

* Update .github/ISSUE_TEMPLATE/bug_report.yml

Co-authored-by: ijemmy <[email protected]>

* Update .github/ISSUE_TEMPLATE/documentation_improvements.yml

Co-authored-by: ijemmy <[email protected]>

* Update .github/ISSUE_TEMPLATE/maintenance.yml

Co-authored-by: ijemmy <[email protected]>

* Update .github/ISSUE_TEMPLATE/maintenance.yml

Co-authored-by: ijemmy <[email protected]>

* Update .github/ISSUE_TEMPLATE/rfc.yml

Co-authored-by: ijemmy <[email protected]>

* Update .github/ISSUE_TEMPLATE/support_powertools.yml

Co-authored-by: ijemmy <[email protected]>

* Update .github/ISSUE_TEMPLATE/feature_request.yml

Co-authored-by: ijemmy <[email protected]>

Co-authored-by: ijemmy <[email protected]>
  • Loading branch information
dreamorosi and ijemmy authored Oct 24, 2022
1 parent 652b7f0 commit f71a79f
Show file tree
Hide file tree
Showing 12 changed files with 475 additions and 198 deletions.
51 changes: 0 additions & 51 deletions .github/ISSUE_TEMPLATE/BUG_REPORT.md

This file was deleted.

38 changes: 0 additions & 38 deletions .github/ISSUE_TEMPLATE/DOC_IMPROVEMENT.md

This file was deleted.

37 changes: 0 additions & 37 deletions .github/ISSUE_TEMPLATE/FEATURE_REQUEST.md

This file was deleted.

71 changes: 0 additions & 71 deletions .github/ISSUE_TEMPLATE/RFC.md

This file was deleted.

89 changes: 89 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
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. Before you start, make sure that [the bug hasn't been reported already](https://github.com/awslabs/aws-lambda-powertools-typescript/issues).
Please add as much information as possible to help us reproduce, and remove any potential sensitive data.
- 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: JavaScript
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 TypeScript version
placeholder: "latest, 1.3.0"
value: latest
validations:
required: true
- type: dropdown
id: runtime
attributes:
label: AWS Lambda function runtime
options:
- 12.x
- 14.x
- 16.x
validations:
required: true
- type: dropdown
id: packaging
attributes:
label: Packaging format used
options:
- Lambda Layers
- Npm
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: Shell
validations:
required: false
- type: markdown
attributes:
value: |
---
**Disclaimer**: After creating an issue, please wait until it is triaged and confirmed by a maintainer before implementing it. This will reduce amount of rework and the chance that a pull request gets rejected.
6 changes: 5 additions & 1 deletion .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1 +1,5 @@
blank_issues_enabled: false
blank_issues_enabled: false
contact_links:
- name: Ask a question
url: https://github.com/awslabs/aws-lambda-powertools-typescript/discussions/new
about: Ask a general question about Lambda Powertools
51 changes: 51 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation_improvements.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
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
- type: markdown
attributes:
value: |
---
**Disclaimer**: After creating an issue, please wait until it is triaged and confirmed by a maintainer before implementing it. This will reduce amount of rework and the chance that a pull request gets rejected.
Loading

0 comments on commit f71a79f

Please sign in to comment.