|
1 | | -TODO |
| 1 | +### Prerequisites |
2 | 2 |
|
3 | | -In the new file, add your issue template. This could include: |
| 3 | +* [ ] Are you running the [latest version of SCIRun](https://github.com/SCIInstitute/SCIRun/releases)? |
| 4 | +[//]: # (* [ ] TODO: Did you check the [debugging guide](http://flight-manual.atom.io/hacking-atom/sections/debugging/)?) |
| 5 | +[//]: # (* [ ] TODO: Did you check the [FAQs on Discuss](https://discuss.atom.io/c/faq)?) |
| 6 | +* [ ] Are you reporting to the [correct repository](https://github.com/SCIInstitute/SCIRun)? |
| 7 | +* [ ] Did you [perform a cursory search](https://github.com/SCIInstitute/SCIRun/issues) to see if your bug or enhancement is already reported? |
4 | 8 |
|
5 | | - Expected behavior and actual behavior. |
6 | | - Steps to reproduce the problem. |
7 | | - Specifications like the version of the project, operating system, or hardware. |
| 9 | +For more information on how to write a good [bug report](https://github.com/atom/atom/blob/master/CONTRIBUTING.md#how-do-i-submit-a-good-bug-report) or [enhancement request](https://github.com/atom/atom/blob/master/CONTRIBUTING.md#how-do-i-submit-a-good-enhancement-suggestion), see the `CONTRIBUTING` guide. These links point to another project, but most of the advice holds in general. |
8 | 10 |
|
9 | | -Example: |
10 | | -https://github.com/atom/atom/blob/master/ISSUE_TEMPLATE.md |
| 11 | +### Description |
| 12 | + |
| 13 | +[Description of the bug or feature] |
| 14 | + |
| 15 | +For Mac crash bugs, please *DO NOT* paste an entire MacOS crash report here. Edit it down to just the stack trace of the thread that crashed, along with the general system info on the top. |
| 16 | + |
| 17 | +**In all bug cases, some combination of screenshots, sample network(s), and input data should be attached. You can use any cloud storage links you want for networks and data.** |
| 18 | + |
| 19 | +### Steps to Reproduce |
| 20 | + |
| 21 | +1. [First Step] |
| 22 | +2. [Second Step] |
| 23 | +3. [and so on...] |
| 24 | + |
| 25 | +**Expected behavior:** [What you expected to happen] |
| 26 | + |
| 27 | +**Actual behavior:** [What actually happened] |
| 28 | + |
| 29 | +### Versions |
| 30 | + |
| 31 | +You can get this information from executing `SCIRun --version` at the command line, or clicking on the version button in the bottom right corner of the GUI (which copies the version to the clipboard). Also, please include the OS and what version of the OS you're running. |
0 commit comments