Skip to content

Commit 3d5366c

Browse files
ajaykarpurknakad
andauthored
doc: Add issue templates and configure issue template chooser (#1242)
* doc: Add issue templates and configure issue template chooser * doc: Edit system information section of bug report template for Python SDK * doc: Change labels in issue templates to match Python SDK convention * doc: Update .github/ISSUE_TEMPLATE/documentation-request.md Co-Authored-By: Karim Nakad <[email protected]> * doc: Update .github/ISSUE_TEMPLATE/feature_request.md Co-Authored-By: Karim Nakad <[email protected]> * doc: Update link for questions in issue template config Co-authored-by: Karim Nakad <[email protected]>
1 parent c8af6e0 commit 3d5366c

File tree

5 files changed

+74
-17
lines changed

5 files changed

+74
-17
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
name: Bug report
3+
about: File a report to help us reproduce and fix the problem
4+
title: ''
5+
labels: 'bug'
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is.
12+
13+
**To reproduce**
14+
A clear, step-by-step set of instructions to reproduce the bug.
15+
16+
**Expected behavior**
17+
A clear and concise description of what you expected to happen.
18+
19+
**Screenshots or logs**
20+
If applicable, add screenshots or logs to help explain your problem.
21+
22+
**System information**
23+
A description of your system. Please provide:
24+
- **SageMaker Python SDK version**:
25+
- **Framework name (eg. PyTorch) or algorithm (eg. KMeans)**:
26+
- **Framework version**:
27+
- **Python version**:
28+
- **CPU or GPU**:
29+
- **Custom Docker image (Y/N)**:
30+
31+
**Additional context**
32+
Add any other context about the problem here.

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 5 additions & 0 deletions
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://stackoverflow.com/questions/tagged/amazon-sagemaker
5+
about: Use Stack Overflow to ask and answer questions
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
name: Documentation request
3+
about: Request improved documentation
4+
title: ''
5+
labels: 'doc update'
6+
assignees: ''
7+
8+
---
9+
10+
**What did you find confusing? Please describe.**
11+
A clear and concise description of what you found confusing. Ex. I tried to [...] but I didn't understand how to [...]
12+
13+
**Describe how documentation can be improved**
14+
A clear and concise description of where documentation was lacking and how it can be improved.
15+
16+
**Additional context**
17+
Add any other context or screenshots about the documentation request here.
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature request
3+
about: Suggest an improvement for this library
4+
title: ''
5+
labels: 'feature request'
6+
assignees: ''
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
15+
16+
**Describe alternatives you've considered**
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
**Additional context**
20+
Add any other context or screenshots about the feature request here.

.github/issue_template.md

Lines changed: 0 additions & 17 deletions
This file was deleted.

0 commit comments

Comments
 (0)