Add issue template #162
Add issue template #162
Conversation
Codecov Report
@@ Coverage Diff @@
## master #162 +/- ##
=======================================
Coverage 90.63% 90.63%
=======================================
Files 37 37
Lines 2478 2478
=======================================
Hits 2246 2246
Misses 232 232Continue to review full report at Codecov.
|
winstonaws
left a comment
winstonaws
left a comment
There was a problem hiding this comment.
Thanks for starting this!
.github/issue_template.md
Outdated
| Please fill out the form below for any bugs. | ||
|
|
||
| ### System Information | ||
| - **Framework**: |
There was a problem hiding this comment.
Not every customer will be using a Framework - some could use 1P or BYO.
|
|
||
| ### System Information | ||
| - **Framework**: | ||
| - **Framework Version**: |
There was a problem hiding this comment.
Can you add short instructions on how to find out the versions?
.github/issue_template.md
Outdated
| - **Framework**: | ||
| - **Framework Version**: | ||
| - **Python SDK Version**: | ||
| - **Are you using a custom container/image**: |
There was a problem hiding this comment.
just image is fine, you don't need container/image.
.github/issue_template.md
Outdated
| - **Framework Version**: | ||
| - **Python SDK Version**: | ||
| - **Are you using a custom container/image**: | ||
| - **Exact command to reproduce**: |
There was a problem hiding this comment.
Is this redundant with the Minimal repo section?
There was a problem hiding this comment.
I moved the command to the bottom, but I think it is still necessary that the minimal repo case should be easy to run.
| Describe the problem or feature request clearly here. | ||
|
|
||
| ### Minimal repo / logs | ||
| Please provide any logs and a bare minimum reproducible test case, as this will be helpful to diagnose the problem. If including tracebacks, please include the full traceback. Large logs and files should be attached. |
There was a problem hiding this comment.
You should state that we need both the estimator/predictor code as well as the user scripts.
There was a problem hiding this comment.
I don't agree with this statement, the minimal repo case isn't always going to need all of this.
.github/issue_template.md
Outdated
| @@ -0,0 +1,14 @@ | |||
| Please fill out the form below for any bugs. | |||
There was a problem hiding this comment.
Maybe "for reporting bugs or requesting debugging help"?
There was a problem hiding this comment.
Maybe it should just be, "Please fill out the form below."
.github/issue_template.md
Outdated
| Please fill out the form below. | ||
|
|
||
| ### System Information | ||
| - **Framework(e.g. TensorFlow) / Algorithm(e.g. KMeans)**: |
There was a problem hiding this comment.
Add space between word and (
3 participants
Issue #, if available:
Description of changes:
Add issue template asking for background information and a minimal repo, in order to help customers in a quicker fashion.
Merge Checklist
Put an
xin the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your pull request.By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.