Skip to content

Commit

Permalink
Add issue templates for SMD repo (#378)
Browse files Browse the repository at this point in the history
  • Loading branch information
aws-tianquaw authored Apr 22, 2024
1 parent 9d6813d commit 0b14842
Show file tree
Hide file tree
Showing 3 changed files with 95 additions and 0 deletions.
61 changes: 61 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
name: 🐛 Bug Report
description: Create a report to help us reproduce and fix the bug.

body:
- type: markdown
attributes:
value: >
#### Before submitting a bug, please make sure the issue hasn't been already addressed by searching through [the existing and past issues](https://github.com/aws/sagemaker-distribution/issues?q=is%3Aissue+sort%3Acreated-desc+).
- type: dropdown
id: category
attributes:
label: Category
description: What is the type of the bug?
options:
- Compatibility Issue
- Image Size Issue
- Performance Issue
- Usability Issue
- Others
validations:
required: true
- type: textarea
attributes:
label: 🐛 Describe the bug
description: |
Please provide a clear and concise description of what the bug is.
If relevant, add a minimal example so that we can reproduce the error by running the code. It is very important for the snippet to be as succinct (minimal) as possible, so please take time to trim down any irrelevant code to help us debug efficiently. We are going to copy-paste your code and we expect to get the same result as you did: avoid any external data, and include the relevant imports, etc.
Please also paste or describe the results you observe.
If you observe an error, please paste the error message including the **full** traceback of the exception. It may be relevant to wrap error messages in ```` ```triple quotes blocks``` ````.
placeholder: |
A clear and concise description of what the bug is. If you have a screenshot of the issue, please upload it here.
```python
# Sample code to reproduce the problem
```
```
The error message you got, with the full traceback.
```
validations:
required: false
- type: textarea
attributes:
label: 🐛 Describe the expected behavior
description: |
Please provide a clear and concise description of the expected behaviors.
validations:
required: false
- type: textarea
attributes:
label: Image Tags
description: |
Please specify which image versions you reproduced the issue on. (e.g. 1.6.1-cpu)
validations:
required: true
- type: markdown
attributes:
value: >
Thanks for contributing 🎉!
4 changes: 4 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
contact_links:
- name: Report a security vulnerability
url: http://aws.amazon.com/security/vulnerability-reporting/
about: This issue tracker is not for security vulnerabilities. Please report issues here.
30 changes: 30 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
name: 🚀 Feature request
description: Submit a proposal/request for a new feature

body:
- type: textarea
attributes:
label: 🚀 The feature, motivation and pitch
description: >
A clear and concise description of the feature proposal. Please outline the motivation for the proposal. Is your feature request related to a specific problem? e.g., *"I'm working on X and would like Y to be possible"*. If this is related to another GitHub issue, please link here too.
validations:
required: true
- type: textarea
attributes:
label: Use case description
description: >
A description of the use cases of your proposed feature, if any.
- type: textarea
attributes:
label: Alternatives
description: >
A description of any alternative solutions or features you have considered, if any.
- type: textarea
attributes:
label: Additional context
description: >
Add any other context or screenshots about the feature request.
- type: markdown
attributes:
value: >
Thanks for contributing 🎉!

0 comments on commit 0b14842

Please sign in to comment.