Skip to content

Commit

Permalink
Merge pull request #2 from ford-at-aws/new-template
Browse files Browse the repository at this point in the history
new issue templates
  • Loading branch information
ford-at-aws authored Aug 2, 2022
2 parents dd0b79f + 5162b6f commit bd3013b
Show file tree
Hide file tree
Showing 11 changed files with 356 additions and 205 deletions.
36 changes: 0 additions & 36 deletions .github/ISSUE_TEMPLATE/bug.md

This file was deleted.

110 changes: 110 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,110 @@
name: Bug Report
description: File a bug report
title: "[Bug]: <DESCRIPTIVE TITLE HERE>"
labels: ["type/bug"]
assignees:
- octocat
body:
- type: markdown
attributes:
value: |
## ⚠️ Warning
Issues that do not follow the below template will be marked `status/back-to-author` and assigned back to the creator.
---
- type: markdown
attributes:
value: |
# 🐛 Bug Details
- type: textarea
id: expected-behavior
attributes:
label: Expected behavior
description: What did you expect to happen?
placeholder: Be specific! Ctrl+Copy screenshots!
validations:
required: true
- type: textarea
id: actual-behavior
attributes:
label: Actual behavior
description: What actually happened?
placeholder: Be specific! Ctrl+Copy screenshots!
validations:
required: true
- type: textarea
id: reproduce
attributes:
label: Steps to reproduce.
description: "How do you trigger this bug? Please walk us through it step by step. NOTE: Screenshots welcome! Just Ctrl+Copy them here."
value: |
1.
2.
3.
render: bash
validations:
required: true
- type: textarea
id: logs
attributes:
label: Logs/stacktrace (if applicable)
description: This will be automatically formatted into code, so no need for backticks.
render: shell
- type: markdown
attributes:
value: |
---
# 🌎 Environment Details
- type: dropdown
id: sdk-type
attributes:
label: Which SDK were you using?
options:
- Java
- Kotlin
- Python
- Ruby
- .NET
- Javascript
- Java v2
- Javascript v3
- Go
- PHP
- Rust
- Swift
- Typescript
validations:
required: true
- type: dropdown
id: operating-system
attributes:
label: Which OS were you using?
options:
- MacOS
- Windows
- Linux
validations:
required: true
- type: input
attributes:
label: SDK Version
description: What version of the SDK were you using?
placeholder: e.g. 1.24.42
value:
validations:
required: false
- type: input
attributes:
label: OS Version
description: What OS version are you using?
placeholder: e.g. Windows 10, macOS Big Sur, Ubuntu 14.2
value:
validations:
required: false
- type: markdown
attributes:
value: |
---
## What's next?
A member of the AWS SDK Example Code will review your issue and reply within 10 business days. In the meantime, we discourage editing the issue but welcome structural edits and additional details! 🙂
82 changes: 82 additions & 0 deletions .github/ISSUE_TEMPLATE/enhancement.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
name: Feature Request
description: Request a new code example
title: "[Enhancement]: <DESCRIPTIVE TITLE HERE>"
labels: ["type/enhancement"]
assignees:
- octocat
body:
- type: markdown
attributes:
value: |
## ⚠️ Warning
Issues that do not follow the below template will be marked `status/back-to-author` and assigned back to the creator.
---
# ✨ Code Example Details
- type: textarea
id: context
attributes:
label: Background story
description: Take a moment and give us some context! Why is this example important to you?
placeholder: Be specific! Ctrl+Copy screenshots!
validations:
required: true
- type: textarea
id: accomplishment
attributes:
label: What does this example accomplish?
description: Provide a clear and brief description of what the code example should do. For example, "I want to upload a file to the cloud."
placeholder: Be specific! Ctrl+Copy screenshots!
validations:
required: true
- type: input
id: which-services
attributes:
label: Which AWS service(s)?
description: List out the [AWS service(s)](https://aws.amazon.com/products/) this code will engage.
placeholder: Be specific!
validations:
required: true
- type: checkboxes
id: lingo-type
attributes:
label: Which AWS SDK's or tools?
options:
- label: Not applicable
- label: AWS CLI
- label: Java
- label: Kotlin
- label: Python
- label: C++
- label: Ruby
- label: .NET
- label: Javascript
- label: Java v2
- label: Javascript v3
- label: Go
- label: PHP
- label: Rust
- label: Swift
- label: Typescript
- type: textarea
id: which-examples
attributes:
label: Are there any existing code examples could be leveraged?
description: Are there any [existing code examples](https://docs.aws.amazon.com/code-samples/latest/catalog/welcome.html) that might provide a foundation?
placeholder: Use hyperlinks!
validations:
required: false
- type: textarea
id: your-code
attributes:
label: Do you have any reference code?
description: This will be automatically formatted into code, so no need for backticks.
render: shell
- type: markdown
attributes:
value: |
---
## What's next?
A member of the AWS SDK Example Code will review your issue and reply within 10 business days. In the meantime, we discourage editing the issue but welcome structural edits and additional details! 🙂
22 changes: 0 additions & 22 deletions .github/ISSUE_TEMPLATE/epic.md

This file was deleted.

89 changes: 89 additions & 0 deletions .github/ISSUE_TEMPLATE/epic.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
name: Epic (Internal Use Only 🔒)
description: Define an initiative that spans multiple user stories.
title: "[Epic]: <DESCRIPTIVE TITLE HERE>"
labels: ["type/epic"]
assignees:
- octocat
body:
- type: markdown
attributes:
value: |
## ⚠️ Warning
Issues that do not follow the below template will be marked `status/back-to-author` and assigned back to the creator.
---
# 📜 Epic Details
- type: textarea
id: context
attributes:
label: Background story
description: What's the big idea with this epic?
placeholder: Be specific! Ctrl+Copy screenshots!
validations:
required: true
- type: textarea
id: accomplishment
attributes:
label: What exactly will this accomplish?
description: Provide a detailed list of your desired outcomes.
placeholder: Be specific! Use bullet-points liberally.
validations:
required: true
- type: textarea
id: user-stories
attributes:
label: 'Child stories'
description: "What atomic stories will make this epic a reality? Titles only."
value: |
1.
2.
3.
render: bash
validations:
required: true
- type: input
id: which-services
attributes:
label: Which AWS service(s)?
description: List out the [AWS service(s)](https://aws.amazon.com/products/) this code will engage.
placeholder: Be specific!
validations:
required: true
- type: checkboxes
id: lingo-type
attributes:
label: Which AWS SDK's or tools?
options:
- label: All languages
- label: AWS CLI
- label: Java
- label: Kotlin
- label: Python
- label: C++
- label: Ruby
- label: .NET
- label: Javascript
- label: Java v2
- label: Javascript v3
- label: Go
- label: PHP
- label: Rust
- label: Swift
- label: Typescript
- label: Not applicable
- type: textarea
id: which-examples
attributes:
label: Is there any existing code that could be leveraged?
description: Check [here](https://docs.aws.amazon.com/code-samples/latest/catalog/welcome.html) for possible scaffolding or foundation.
placeholder: Use hyperlinks!
validations:
required: false
- type: markdown
attributes:
value: |
---
## What's next?
A member of the AWS SDK Example Code will review your issue and reply within 10 business days. In the meantime, we discourage editing the issue but welcome structural edits and additional details! 🙂
Loading

0 comments on commit bd3013b

Please sign in to comment.