summaryrefslogtreecommitdiff
path: root/issue_template.md
diff options
context:
space:
mode:
authorMassimiliano Culpo <massimiliano.culpo@googlemail.com>2017-11-13 10:51:53 -0700
committerChristoph Junghans <christoph.junghans@gmail.com>2017-11-13 10:51:53 -0700
commit2d6cccdc53a6420b9b57c095c152df211df19dda (patch)
tree63950f9a01c4318321415f744bc97859832d733f /issue_template.md
parentbde727e1876bd707f9aefece920a13077562ffee (diff)
downloadspack-2d6cccdc53a6420b9b57c095c152df211df19dda.tar.gz
spack-2d6cccdc53a6420b9b57c095c152df211df19dda.tar.bz2
spack-2d6cccdc53a6420b9b57c095c152df211df19dda.tar.xz
spack-2d6cccdc53a6420b9b57c095c152df211df19dda.zip
Added an issue template for Github (#6205)
The MD file has been added in the root folder, as CONTRIBUTING.md
Diffstat (limited to 'issue_template.md')
-rw-r--r--issue_template.md36
1 files changed, 36 insertions, 0 deletions
diff --git a/issue_template.md b/issue_template.md
new file mode 100644
index 0000000000..bfe89e388c
--- /dev/null
+++ b/issue_template.md
@@ -0,0 +1,36 @@
+If you want to report a build error for some package, or a bug in core please use the following template as a guideline:
+
+-----
+
+Summary
+
+### Expected Result
+
+What you expected
+
+### Actual Result
+
+What happened instead
+
+### Steps to reproduce the issue
+
+```console
+$ spack <command1> <spec>
+$ spack <command2> <spec>
+...
+```
+
+### Information on your system
+
+This includes:
+
+ 1. which platform you are using
+ 2. any relevant configuration detail (custom `packages.yaml` or `modules.yaml`, etc.)
+
+-----
+
+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