summaryrefslogtreecommitdiff
path: root/.github/ISSUE_TEMPLATE
diff options
context:
space:
mode:
authorAdam J. Stewart <ajstewart426@gmail.com>2020-04-03 01:12:03 -0500
committerGitHub <noreply@github.com>2020-04-02 23:12:03 -0700
commit75a2f8046a5782dc227f2679d6860558db4b1bfb (patch)
tree81b527da07fb920d480c0fe3dd11d07596fe97fa /.github/ISSUE_TEMPLATE
parent1662c3581bb8e07a4a59841b31354877b24ed7c9 (diff)
downloadspack-75a2f8046a5782dc227f2679d6860558db4b1bfb.tar.gz
spack-75a2f8046a5782dc227f2679d6860558db4b1bfb.tar.bz2
spack-75a2f8046a5782dc227f2679d6860558db4b1bfb.tar.xz
spack-75a2f8046a5782dc227f2679d6860558db4b1bfb.zip
Add commands to facilitate Spack/Python/OS reporting (#15834)
* Add --version arg to spack python command * Add `spack debug report` command
Diffstat (limited to '.github/ISSUE_TEMPLATE')
-rw-r--r--.github/ISSUE_TEMPLATE/bug_report.md48
1 files changed, 13 insertions, 35 deletions
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
index b38a677416..9a568285ea 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -1,21 +1,11 @@
---
-name: "\U0001F41E Bug report"
-about: Report a bug in the core of Spack (command not working as expected, etc.)
+name: "\U0001F41E Bug report"
+about: Report a bug in the core of Spack (command not working as expected, etc.)
labels: "bug,triage"
---
-<!--
-*Explain, in a clear and concise way, the command you ran and the result you were trying to achieve.
-Example: "I ran Spack find to list all the installed packages and..."*
--->
-
-
-### Spack version
-<!-- Add the output to the command below -->
-```console
-$ spack --version
-
-```
+<!-- Explain, in a clear and concise way, the command you ran and the result you were trying to achieve.
+Example: "I ran `spack find` to list all the installed packages and ..." -->
### Steps to reproduce the issue
@@ -27,38 +17,26 @@ $ spack <command2> <spec>
### Error Message
-<!--If Spack reported an error, provide the error message. If it did not report an error
-but the output appears incorrect, provide the incorrect output. If there was no error
-message and no output but the result is incorrect, describe how it does not match
-what you expect. To provide more information you might re-run the commands with
-the additional -d/--stacktrace flags:
+<!-- If Spack reported an error, provide the error message. If it did not report an error but the output appears incorrect, provide the incorrect output. If there was no error message and no output but the result is incorrect, describe how it does not match what you expect. -->
```console
-$ spack -d --stacktrace <command1> <spec>
-$ spack -d --stacktrace <command2> <spec>
-...
+$ spack --debug --stacktrace <command>
```
-that activate the full debug output.
--->
### Information on your system
-<!--
-This includes:
- 1. which platform you are using
- 2. any relevant configuration detail (custom `packages.yaml` or `modules.yaml`, etc.)
+<!-- Please include the output of `spack debug report` -->
--->
+<!-- If you have any relevant configuration detail (custom `packages.yaml` or `modules.yaml`, etc.) you can add that here as well. -->
-### General information
+### Additional information
-- [ ] I have run `spack --version` and reported the version of Spack
+<!-- These boxes can be checked by replacing [ ] with [x] or by clicking them after submitting the issue. -->
+- [ ] I have run `spack debug report` and reported the version of Spack/Python/Platform
- [ ] I have searched the issues of this repo and believe this is not a duplicate
- [ ] I have run the failing commands in debug mode and reported the output
-<!--
-We encourage you to try, as much as possible, to reduce your problem to the minimal example that still reproduces the issue. That would help us a lot in fixing it quickly and effectively!
+<!-- We encourage you to try, as much as possible, to reduce your problem to the minimal example that still reproduces the issue. That would help us a lot in fixing it quickly and effectively!
If you want to ask a question about the tool (how to use it, what it can currently do, etc.), try the `#general` channel on our Slack first. We have a welcoming community and chances are you'll get your reply faster and without opening an issue.
-Other than that, thanks for taking the time to contribute to Spack!
---> \ No newline at end of file
+Other than that, thanks for taking the time to contribute to Spack! -->