Create ISSUE_TEMPLATE.md
* Suggestion for an issue template to help with the amount of issues
This commit is contained in:
parent
5efb724a3e
commit
59c4ed106c
|
@ -0,0 +1,35 @@
|
|||
#### Requirements
|
||||
|
||||
These items you must provide answers to.
|
||||
|
||||
Make sure to add **all the information needed to understand the bug** so that someone can help:
|
||||
|
||||
* Provide the rule id if refering to a specific rule. e.g., `SC1000`
|
||||
* Provide **screenshots** where appropriate
|
||||
* Sample shell script (wrapped in fenced code)
|
||||
|
||||
Please acknowledge that you understand by marking off the following list items below with an 'x'
|
||||
|
||||
_--- ✂ snip ✂ --- Delete this line and all of the ^above^ after reading and before submitting your issue please --- ✂ snip ✂ ---_
|
||||
|
||||
#### Issue Title
|
||||
|
||||
ISSUE TITLE HERE
|
||||
|
||||
#### Required Info
|
||||
|
||||
- [ ] I have searched the [issues](https://github.com/koalaman/shellcheck/issues) for my issue and found nothing related and/or helpful
|
||||
- [ ] I have read or at least glanced at the [Wiki](https://github.com/koalaman/shellcheck/wiki)
|
||||
- [ ] What **version** of shellcheck are you using?
|
||||
- hint: `shellcheck --version`
|
||||
- [ ] What is your environment/OS ?
|
||||
|
||||
#### Optional Info
|
||||
|
||||
- [ ] Rule id: [RULE_GOES_HERE](https://github.com/koalaman/shellcheck/wiki/RULE_GOES_HERE)
|
||||
- [ ] Screenshot
|
||||
- [ ] Sample script
|
||||
```sh
|
||||
#!/bin/bash
|
||||
#...
|
||||
```
|
Loading…
Reference in New Issue