aboutsummaryrefslogtreecommitdiffhomepage
path: root/ISSUE_TEMPLATE.md
diff options
context:
space:
mode:
authorGravatar Neal Wu <neal@nealwu.com>2017-04-24 13:01:19 -0700
committerGravatar drpngx <drpngx@users.noreply.github.com>2017-04-24 13:01:19 -0700
commit28091dce41045570b7d92eb912eddce0079c0234 (patch)
treeb6729508133db5ce3e89f59fdec9c5399c39af2a /ISSUE_TEMPLATE.md
parent34c738cc6d3badcb22e3f72482536ada29bd0e65 (diff)
Full set of changes to ISSUE_TEMPLATE.md (#9390)
* Full set of changes to ISSUE_TEMPLATE.md * Put links on separate lines * Remove extra newline
Diffstat (limited to 'ISSUE_TEMPLATE.md')
-rw-r--r--ISSUE_TEMPLATE.md23
1 files changed, 9 insertions, 14 deletions
diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md
index e653ed2fa3..6f4c048ce8 100644
--- a/ISSUE_TEMPLATE.md
+++ b/ISSUE_TEMPLATE.md
@@ -1,4 +1,5 @@
-Please go to Stack Overflow for help and support.
+Please go to Stack Overflow for help and support:
+
http://stackoverflow.com/questions/tagged/tensorflow
If you open a GitHub issue, here is our policy:
@@ -6,11 +7,7 @@ If you open a GitHub issue, here is our policy:
1. It must be a bug or a feature request.
2. The form below must be filled out.
-**Here's why we have that policy**: TensorFlow developers respond to issues.
-We want to focus on work that benefits the whole community, e.g., fixing
-bugs and adding features. Support only helps individuals. GitHub also notifies
-thousands of people when issues are filed. We want them to see you communicating
-an interesting problem, rather than being redirected to Stack Overflow.
+**Here's why we have that policy**: TensorFlow developers respond to issues. We want to focus on work that benefits the whole community, e.g., fixing bugs and adding features. Support only helps individuals. GitHub also notifies thousands of people when issues are filed. We want them to see you communicating an interesting problem, rather than being redirected to Stack Overflow.
------------------------
@@ -25,17 +22,15 @@ an interesting problem, rather than being redirected to Stack Overflow.
- **Exact command to reproduce**:
You can collect some of this information using our environment capture script:
+
https://github.com/tensorflow/tensorflow/tree/master/tools/tf_env_collect.sh
-You can collect the TensorFlow version with
-```sh
-python -c "import tensorflow as tf; print (tf.GIT_VERSION, tf.VERSION)"
-```
+You can obtain the TensorFlow version with
+
+python -c "import tensorflow as tf; print(tf.GIT_VERSION, tf.VERSION)"
### Describe the problem
+Describe the problem clearly here. Be sure to convey here why it's a bug in TensorFlow or a feature request.
### Source code / logs
-Include any logs or source code that would be helpful to diagnose the problem.
-If including tracebacks, please include the full traceback. Large logs and files
-should be attached. Try to provide a reproducible test case that is the minimum
-necessary to generate the problem.
+Include any logs or source code that would be helpful to diagnose the problem. If including tracebacks, please include the full traceback. Large logs and files should be attached. Try to provide a reproducible test case that is the bare minimum necessary to generate the problem.