Skip to content

Commit 1233ce0

Browse files
committed
Add GitHub issue template
Closes #216. This should make it easier for people to file high-quality issues. Tweaked CONTRIBUTING.md accordingly, and fixed a stale reference to mbland/custom-links.
1 parent 34d937b commit 1233ce0

File tree

2 files changed

+35
-4
lines changed

2 files changed

+35
-4
lines changed

.github/ISSUE_TEMPLATE.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
## Due diligence
2+
3+
- [ ] I am familiar with the ["Reporting issues" section of
4+
CONTRIBUTING.md][reporting]
5+
- [ ] I have searched the [existing issues][issues] and haven't found one
6+
that matches what I'm reporting or requesting now.
7+
- [ ] If this is a bug report, I have searched the [Bash changelog][changes]
8+
for information that may explain or provide clues to the behavior I'm
9+
observing and reference it in the body of the report.
10+
11+
[reporting]: https://github.com/mbland/go-script-bash/blob/master/CONTRIBUTING.md#reporting-issues
12+
[issues]: https://github.com/mbland/go-script-bash/issues
13+
[changes]: https://tiswww.case.edu/php/chet/bash/CHANGES
14+
15+
## Framework, Bash, and operating system version information
16+
17+
```
18+
If this is a bug report, replace this preformatted section with the output from:
19+
20+
$ ./go goinfo
21+
22+
Otherwise remove this section altogether.
23+
```
24+
25+
## Description
26+
27+
Replace this text with a description of your bug report or feature request.
28+
29+
If this is a bug report, include any relevant command line steps, code snippets,
30+
or test cases to reproduce the issue.

CONTRIBUTING.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ been filed.
6666

6767
If you do find one...
6868

69-
[issues]: https://github.com/mbland/custom-links/issues
69+
[issues]: https://github.com/mbland/go-script-bash/issues
7070

7171
### Do not add a +1 comment!
7272

@@ -84,10 +84,11 @@ matching issue...
8484
Try to be as specific as possible about your environment and the problem you're
8585
observing. At a minimum, include:
8686

87-
- The version of bash you're using, from either `bash --version` or `echo
88-
$BASH_VERSION`
89-
- The version of the go-script-bash library you're using
87+
- The output from `./go goinfo`
9088
- Command line steps or code snippets that reproduce the issue
89+
- Any apparently relevant information from the [Bash changelog][bash-changes]
90+
91+
[bash-changes]: https://tiswww.case.edu/php/chet/bash/CHANGES
9192

9293
Also consider using:
9394

0 commit comments

Comments
 (0)