summaryrefslogtreecommitdiff
path: root/.github/ISSUE_TEMPLATE.md
diff options
context:
space:
mode:
authorRichard Zou <zou3519@users.noreply.github.com>2018-04-22 15:18:14 -0400
committerEdward Z. Yang <ezyang@mit.edu>2018-04-22 15:18:14 -0400
commit7a3c38ab595ea78f16935df788c4982a0ec56966 (patch)
tree95fcfe023746c9063e59551df071658d23a03c74 /.github/ISSUE_TEMPLATE.md
parent56567fe47dafcb77222c366cca0ac73f557bf4df (diff)
downloadpytorch-7a3c38ab595ea78f16935df788c4982a0ec56966.tar.gz
pytorch-7a3c38ab595ea78f16935df788c4982a0ec56966.tar.bz2
pytorch-7a3c38ab595ea78f16935df788c4982a0ec56966.zip
Add environment collection script (#6635)
* Add environment collection script Fixes #6111. This should make it easier for users to report bugs by giving them a script to collect system environment information. Changes include: - Refactor out the environment collecting code from utils.bottleneck - Add script (collect_env.py) - Cleaned up the issues template so that it suggests using the script and is more readable. Testing: added expect tests to go with 4 CI configurations. Whenever one of these configurations gets updated, the test will fail until the test also gets updated. * Expect tests * Update issue template * Fix random space * Minor improvement to issue template; fix expect test * Skip expect test if BUILD_ENVIRONMENT not found; test fix; split off smoke/expect test
Diffstat (limited to '.github/ISSUE_TEMPLATE.md')
-rw-r--r--.github/ISSUE_TEMPLATE.md38
1 files changed, 26 insertions, 12 deletions
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
index d993127645..3447f75846 100644
--- a/.github/ISSUE_TEMPLATE.md
+++ b/.github/ISSUE_TEMPLATE.md
@@ -1,24 +1,38 @@
-PyTorch GitHub Issues Guidelines
---------------------------------
-
-We like to limit our issues to bug reports and feature requests. If you have a question or would like help and support, please visit our forums: https://discuss.pytorch.org/
+If you have a question or would like help and support, please ask at our
+[forums](https://discuss.pytorch.org/).
If you are submitting a feature request, please preface the title with [feature request].
+If you are submitting a bug report, please fill in the following details.
+
+## Issue description
+
+Provide a short description.
+
+## Code example
+
+Please try to provide a minimal example to repro the bug.
+Error messages and stack traces are also helpful.
+
+## System Info
+Please copy and paste the output from our
+[environment collection script](https://github.com/pytorch/pytorch/tree/master/torch/utils/collect_env.py)
+(or fill out the checklist below manually).
+
+You can get the script and run it with:
+```
+wget https://github.com/pytorch/pytorch/tree/master/torch/utils/collect_env.py
+# For security purposes, please check the contents of collect_env.py before running it.
+python collect_env.py
+```
-When submitting a bug report, please include the following information (where relevant):
- PyTorch or Caffe2:
+- How you installed PyTorch (conda, pip, source):
+- Build command you used (if compiling from source):
- OS:
- PyTorch version:
-- How you installed PyTorch (conda, pip, source):
- Python version:
- CUDA/cuDNN version:
- GPU models and configuration:
- GCC version (if compiling from source):
- CMake version:
-- Build command you used (if compiling from source):
- Versions of any other relevant libraries:
-
-In addition, including the following information will also be very helpful for us to diagnose the problem:
-- A script to reproduce the bug. Please try to provide as minimal of a test case as possible.
-- Error messages and/or stack traces of the bug
-- Context around what you are trying to do