Skip to content

Commit

Permalink
new issue templates in yml format (#1480)
Browse files Browse the repository at this point in the history
Changed the issue templates to use the '.yml' format, allowing for required fields.
Almost no changes to actual content.
  • Loading branch information
KaibaLopez committed Nov 9, 2021
1 parent 468a3bc commit 34341ea
Show file tree
Hide file tree
Showing 8 changed files with 179 additions and 74 deletions.
31 changes: 0 additions & 31 deletions .github/ISSUE_TEMPLATE/bug-report.md

This file was deleted.

88 changes: 88 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yml
@@ -0,0 +1,88 @@
name: "\U0001F41B Bug Report"
description: File a bug report
title: "(short issue description)"
labels: [bug, needs-triage]
body:
- type: checkboxes
id: terms
attributes:
label: Documentation
description: Please confirm.
options:
- label: I've gone though the [API reference](https://docs.aws.amazon.com/sdk-for-go/v2/api/)
required: true
- label: I've checked [AWS Forums](https://forums.aws.amazon.com) and [StackOverflow](https://stackoverflow.com/questions/tagged/aws-sdk-go) for answers
required: true
- label: I've searched for [previous similar issues](https://github.com/aws/aws-sdk-go-v2/issues) and didn't find any solution
required: true

- type: textarea
id: description
attributes:
label: Describe the bug
description: A clear and concise description of what the bug is.
validations:
required: true

- type: textarea
id: expected
attributes:
label: Expected behavior
description: |
Tell us what should happen.
validations:
required: true

- type: textarea
id: current
attributes:
label: Current behavior
description: |
Tell us what happens instead of the expected behavior.
Include full errors, uncaught exceptions, stack traces, and relevant logs.
To turn on SDK logging, follow instructions here: http://docs.aws.amazon.com/sdk-for-java/v2/developer-guide/java-dg-logging.html
If service responses are relevant, please include wirelogs.
validations:
required: true

- type: textarea
id: reproduction
attributes:
label: Steps to Reproduce
description: |
Provide a self-contained, concise snippet of code that can be used to reproduce the issue.
For more complex issues provide a repo with the smallest sample that reproduces the bug.
Avoid including business logic or unrelated code, it makes diagnosis more difficult.
validations:
required: true

- type: textarea
id: solution
attributes:
label: Possible Solution
description: |
Suggest a fix/reason for the bug
validations:
required: false

- type: input
id: Go-sdk-version
attributes:
label: AWS Go SDK version used
validations:
required: true

- type: input
id: go-version
attributes:
label: Compiler and Version used
description: output of the `go version` command
validations:
required: true

- type: input
id: operating-system
attributes:
label: Operating System and version
validations:
required: true
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1 @@
blank_issues_enabled: false
23 changes: 0 additions & 23 deletions .github/ISSUE_TEMPLATE/documentation.md

This file was deleted.

28 changes: 28 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.yml
@@ -0,0 +1,28 @@
name: "\U0001F4DD Documentation Report"
description: Suggest incorrect/improvement in documentation
title: "(short issue description)"
labels: [documentation, needs-triage]
body:
- type: textarea
id: description
attributes:
label: Describe the issue with documentation
description: A clear and concise description of what the issue is.
validations:
required: true

- type: textarea
id: solution
attributes:
label: Suggestion
description: |
Suggest a fix,improvement or addition you'd like to see in the documentation.
validations:
required: false

- type: input
id: Go-sdk-version
attributes:
label: AWS Go SDK version used
validations:
required: false
20 changes: 0 additions & 20 deletions .github/ISSUE_TEMPLATE/feature-request.md

This file was deleted.

62 changes: 62 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.yml
@@ -0,0 +1,62 @@
name: "\U0001F680 Feature Request"
description: Suggest an idea for this project
title: "(short issue description)"
labels: [feature-request, needs-triage]
body:
- type: textarea
id: description
attributes:
label: Describe the feature
description: A clear and concise description of the feature you are proposing.
validations:
required: true

- type: textarea
id: problem
attributes:
label: Is your Feature Request related to a problem?
description: |
A description of the issue, e.g. "I'm always frustrated when..."
validations:
required: true

- type: textarea
id: solution
attributes:
label: Proposed Solution
description: |
Suggest how to implement the addition or change.
validations:
required: false

- type: textarea
id: alternatives
attributes:
label: Describe alternatives you've considered
description: |
Any alternative solutions or features you've considered.
validations:
required: false

- type: checkboxes
id: acknowledgment
attributes:
label: Acknowledge
options:
- label: I may be able to implement this feature request
required: false

- type: input
id: go-sdk-version
attributes:
label: AWS Go SDK version used
validations:
required: true

- type: input
id: go-version
attributes:
label: Go version used
description: Output of `go version`
validations:
required: true
File renamed without changes.

0 comments on commit 34341ea

Please sign in to comment.