Use the new cool Github templates (#25118)
* Use the new cool github templates * Add the "mention maintainers" clause * Fix broken HTML tag * Minor improvements, missing filenames
This commit is contained in:
gpotter2
GitHub
parent
b4c6c11e68
commit
b1abfd3ff6
7 changed files with 164 additions and 118 deletions
42
.github/ISSUE_TEMPLATE/bug_report.md
vendored
42
.github/ISSUE_TEMPLATE/bug_report.md
vendored
|
|
@ -1,42 +0,0 @@
|
||||||
---
|
|
||||||
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 ..." -->
|
|
||||||
|
|
||||||
### Steps to reproduce the issue
|
|
||||||
|
|
||||||
```console
|
|
||||||
$ spack <command1> <spec>
|
|
||||||
$ 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. -->
|
|
||||||
```console
|
|
||||||
$ spack --debug --stacktrace <command>
|
|
||||||
```
|
|
||||||
|
|
||||||
### Information on your system
|
|
||||||
|
|
||||||
<!-- 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. -->
|
|
||||||
|
|
||||||
### Additional information
|
|
||||||
|
|
||||||
<!-- 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!
|
|
||||||
|
|
||||||
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! -->
|
|
||||||
58
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
Normal file
58
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
Normal file
|
|
@ -0,0 +1,58 @@
|
||||||
|
name: "\U0001F41E Bug report"
|
||||||
|
description: Report a bug in the core of Spack (command not working as expected, etc.)
|
||||||
|
labels: [bug, triage]
|
||||||
|
body:
|
||||||
|
- type: textarea
|
||||||
|
id: reproduce
|
||||||
|
attributes:
|
||||||
|
label: Steps to reproduce
|
||||||
|
description: |
|
||||||
|
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 ..."
|
||||||
|
placeholder: |
|
||||||
|
```console
|
||||||
|
$ spack <command1> <spec>
|
||||||
|
$ spack <command2> <spec>
|
||||||
|
...
|
||||||
|
```
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
id: error
|
||||||
|
attributes:
|
||||||
|
label: Error message
|
||||||
|
description: |
|
||||||
|
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.
|
||||||
|
placeholder: |
|
||||||
|
```console
|
||||||
|
$ spack --debug --stacktrace <command>
|
||||||
|
```
|
||||||
|
- type: textarea
|
||||||
|
id: information
|
||||||
|
attributes:
|
||||||
|
label: Information on your system
|
||||||
|
description: Please include the output of `spack debug report`
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: |
|
||||||
|
If you have any relevant configuration detail (custom `packages.yaml` or `modules.yaml`, etc.) you can add that here as well.
|
||||||
|
- type: checkboxes
|
||||||
|
id: checks
|
||||||
|
attributes:
|
||||||
|
label: General information
|
||||||
|
options:
|
||||||
|
- label: I have run `spack debug report` and reported the version of Spack/Python/Platform
|
||||||
|
required: true
|
||||||
|
- label: I have searched the issues of this repo and believe this is not a duplicate
|
||||||
|
required: true
|
||||||
|
- label: I have run the failing commands in debug mode and reported the output
|
||||||
|
required: true
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: |
|
||||||
|
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](https://slack.spack.io/) 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!
|
||||||
43
.github/ISSUE_TEMPLATE/build_error.md
vendored
43
.github/ISSUE_TEMPLATE/build_error.md
vendored
|
|
@ -1,43 +0,0 @@
|
||||||
---
|
|
||||||
name: "\U0001F4A5 Build error"
|
|
||||||
about: Some package in Spack didn't build correctly
|
|
||||||
title: "Installation issue: "
|
|
||||||
labels: "build-error"
|
|
||||||
---
|
|
||||||
|
|
||||||
<!-- Thanks for taking the time to report this build failure. To proceed with the report please:
|
|
||||||
|
|
||||||
1. Title the issue "Installation issue: <name-of-the-package>".
|
|
||||||
2. Provide the information required below.
|
|
||||||
|
|
||||||
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! -->
|
|
||||||
|
|
||||||
### Steps to reproduce the issue
|
|
||||||
|
|
||||||
<!-- Fill in the exact spec you are trying to build and the relevant part of the error message -->
|
|
||||||
```console
|
|
||||||
$ spack install <spec>
|
|
||||||
...
|
|
||||||
```
|
|
||||||
|
|
||||||
### Information on your system
|
|
||||||
|
|
||||||
<!-- 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. -->
|
|
||||||
|
|
||||||
### Additional information
|
|
||||||
|
|
||||||
<!-- Please upload the following files. They should be present in the stage directory of the failing build. Also upload any config.log or similar file if one exists. -->
|
|
||||||
* [spack-build-out.txt]()
|
|
||||||
* [spack-build-env.txt]()
|
|
||||||
|
|
||||||
<!-- Some packages have maintainers who have volunteered to debug build failures. Run `spack maintainers <name-of-the-package>` and @mention them here if they exist. -->
|
|
||||||
|
|
||||||
### General information
|
|
||||||
|
|
||||||
<!-- 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 run `spack maintainers <name-of-the-package>` and @mentioned any maintainers
|
|
||||||
- [ ] I have uploaded the build log and environment files
|
|
||||||
- [ ] I have searched the issues of this repo and believe this is not a duplicate
|
|
||||||
64
.github/ISSUE_TEMPLATE/build_error.yml
vendored
Normal file
64
.github/ISSUE_TEMPLATE/build_error.yml
vendored
Normal file
|
|
@ -0,0 +1,64 @@
|
||||||
|
name: "\U0001F4A5 Build error"
|
||||||
|
description: Some package in Spack didn't build correctly
|
||||||
|
title: "Installation issue: "
|
||||||
|
labels: [build-error]
|
||||||
|
body:
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: |
|
||||||
|
Thanks for taking the time to report this build failure. To proceed with the report please:
|
||||||
|
1. Title the issue `Installation issue: <name-of-the-package>`.
|
||||||
|
2. Provide the information required below.
|
||||||
|
|
||||||
|
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!
|
||||||
|
- type: textarea
|
||||||
|
id: reproduce
|
||||||
|
attributes:
|
||||||
|
label: Steps to reproduce the issue
|
||||||
|
description: |
|
||||||
|
Fill in the exact spec you are trying to build and the relevant part of the error message
|
||||||
|
placeholder: |
|
||||||
|
```console
|
||||||
|
$ spack install <spec>
|
||||||
|
...
|
||||||
|
```
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
id: information
|
||||||
|
attributes:
|
||||||
|
label: Information on your system
|
||||||
|
description: Please include the output of `spack debug report`
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: |
|
||||||
|
If you have any relevant configuration detail (custom `packages.yaml` or `modules.yaml`, etc.) you can add that here as well.
|
||||||
|
- type: textarea
|
||||||
|
id: additional_information
|
||||||
|
attributes:
|
||||||
|
label: Additional information
|
||||||
|
description: |
|
||||||
|
Please upload the following files:
|
||||||
|
* **`spack-build-out.txt`**
|
||||||
|
* **`spack-build-env.txt`**
|
||||||
|
|
||||||
|
They should be present in the stage directory of the failing build. Also upload any `config.log` or similar file if one exists.
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: |
|
||||||
|
Some packages have maintainers who have volunteered to debug build failures. Run `spack maintainers <name-of-the-package>` and **@mention** them here if they exist.
|
||||||
|
- type: checkboxes
|
||||||
|
id: checks
|
||||||
|
attributes:
|
||||||
|
label: General information
|
||||||
|
options:
|
||||||
|
- label: I have run `spack debug report` and reported the version of Spack/Python/Platform
|
||||||
|
required: true
|
||||||
|
- label: I have run `spack maintainers <name-of-the-package>` and **@mentioned** any maintainers
|
||||||
|
required: true
|
||||||
|
- label: I have uploaded the build log and environment files
|
||||||
|
required: true
|
||||||
|
- label: I have searched the issues of this repo and believe this is not a duplicate
|
||||||
|
required: true
|
||||||
1
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
1
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
blank_issues_enabled: true
|
||||||
33
.github/ISSUE_TEMPLATE/feature_request.md
vendored
33
.github/ISSUE_TEMPLATE/feature_request.md
vendored
|
|
@ -1,33 +0,0 @@
|
||||||
---
|
|
||||||
name: "\U0001F38A Feature request"
|
|
||||||
about: Suggest adding a feature that is not yet in Spack
|
|
||||||
labels: feature
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
<!--*Please add a concise summary of your suggestion here.*-->
|
|
||||||
|
|
||||||
### Rationale
|
|
||||||
|
|
||||||
<!--*Is your feature request related to a problem? Please describe it!*-->
|
|
||||||
|
|
||||||
### Description
|
|
||||||
|
|
||||||
<!--*Describe the solution you'd like and the alternatives you have considered.*-->
|
|
||||||
|
|
||||||
|
|
||||||
### Additional information
|
|
||||||
<!--*Add any other context about the feature request here.*-->
|
|
||||||
|
|
||||||
|
|
||||||
### General information
|
|
||||||
|
|
||||||
- [ ] I have run `spack --version` and reported the version of Spack
|
|
||||||
- [ ] I have searched the issues of this repo and believe this is not a duplicate
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<!--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!
|
|
||||||
-->
|
|
||||||
41
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
Normal file
41
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
Normal file
|
|
@ -0,0 +1,41 @@
|
||||||
|
name: "\U0001F38A Feature request"
|
||||||
|
description: Suggest adding a feature that is not yet in Spack
|
||||||
|
labels: [feature]
|
||||||
|
body:
|
||||||
|
- type: textarea
|
||||||
|
id: summary
|
||||||
|
attributes:
|
||||||
|
label: Summary
|
||||||
|
description: Please add a concise summary of your suggestion here.
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
id: rationale
|
||||||
|
attributes:
|
||||||
|
label: Rationale
|
||||||
|
description: Is your feature request related to a problem? Please describe it!
|
||||||
|
- type: textarea
|
||||||
|
id: description
|
||||||
|
attributes:
|
||||||
|
label: Description
|
||||||
|
description: Describe the solution you'd like and the alternatives you have considered.
|
||||||
|
- type: textarea
|
||||||
|
id: additional_information
|
||||||
|
attributes:
|
||||||
|
label: Additional information
|
||||||
|
description: Add any other context about the feature request here.
|
||||||
|
- type: checkboxes
|
||||||
|
id: checks
|
||||||
|
attributes:
|
||||||
|
label: General information
|
||||||
|
options:
|
||||||
|
- label: I have run `spack --version` and reported the version of Spack
|
||||||
|
required: true
|
||||||
|
- label: I have searched the issues of this repo and believe this is not a duplicate
|
||||||
|
required: true
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: |
|
||||||
|
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](https://slack.spack.io/) 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!
|
||||||
Loading…
Reference in a new issue