aboutsummaryrefslogtreecommitdiffhomepage
path: root/ISSUE_TEMPLATE.md
diff options
context:
space:
mode:
authorGravatar Shanqing Cai <cais@google.com>2017-04-22 21:23:39 -0400
committerGravatar drpngx <drpngx@users.noreply.github.com>2017-04-22 18:23:39 -0700
commit921947028277dd1dbbed0ac1e64a41fcce12cc61 (patch)
tree94285548112a197424d47d52ff4cf5f1f62e318c /ISSUE_TEMPLATE.md
parente40c9f7c57df948231fb5808d1930a56f2d58d85 (diff)
Improve ISSUE_TEMPLATE.md (#9385)
* Improve ISSUE_TEMPLATE.md * Fix system information section
Diffstat (limited to 'ISSUE_TEMPLATE.md')
-rw-r--r--ISSUE_TEMPLATE.md44
1 files changed, 26 insertions, 18 deletions
diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md
index d0979e87f7..e653ed2fa3 100644
--- a/ISSUE_TEMPLATE.md
+++ b/ISSUE_TEMPLATE.md
@@ -1,33 +1,41 @@
-Please go to Stack Overflow for help and support. http://stackoverflow.com/questions/tagged/tensorflow
+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:
-1. It must be a bug or feature request.
+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.
------------------------
-Describe the problem clearly here. Be sure to convey here why it's a bug in TensorFlow or a feature request.
+### System information
+- **Have I written custom code (as opposed to using a stock example script provided in TensorFlow)**:
+- **OS Platform and Distribution (e.g., Linux Ubuntu 16.04)**:
+- **TensorFlow installed from (source or binary)**:
+- **TensorFlow version (use command below)**:
+- **Bazel version (if compiling from source)**:
+- **CUDA/cuDNN version**:
+- **GPU model and memory**:
+- **Exact command to reproduce**:
-### System Information
-- *Have I written custom code (as opposed to using a stock example script provided in TensorFlow)?*:
-- *OS Platform and Distribution (i.e. Linux Ubuntu 16.0)*:
-- *TensorFlow installed from (source or binary)?*:
-- *TensorFlow version* (use command below):
-- *Bazel version (if compiling from source)*:
-- *CUDA/cuDNN version*:
-- *GPU Model and Memory*:
-- *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 some of this information using our environment capture script https://github.com/tensorflow/tensorflow/blob/master/tools/
You can collect the TensorFlow version with
```sh
python -c "import tensorflow as tf; print (tf.GIT_VERSION, tf.VERSION)"
```
+### Describe the problem
-### Describe the problem clearly
-
-### 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 reproducible test-case code the bare-minimum necessary to generate the problem
+### 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.