Skip to content

Commit 5f66541

Browse files
committed
Second draft of issue template
1 parent bc18087 commit 5f66541

File tree

1 file changed

+40
-35
lines changed

1 file changed

+40
-35
lines changed

.github/issue_template.md

Lines changed: 40 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,48 +1,53 @@
1-
### Background
2-
<!-- A quick description of what you're trying to do -->
1+
### Description
2+
<!-- A quick description of what you're trying to accomplish -->
33

4-
### Expected behavior
5-
<!-- Tell us what should happen -->
6-
7-
### Actual behavior
8-
<!-- Tell us what happens instead -->
9-
10-
### Example
4+
### Issue
115

126
<!--
13-
We want to resolve this problem quickly, and in order to that we need to understand it. The better the example, the sooner this issue can be resolved. With that in mind pick _one_ below:
7+
What went wrong? (If this issue is a general question or a proposed change,
8+
feel free to delete this and subsequent sections.
149
-->
1510

16-
#### New testdouble.js test
17-
<!--
18-
1. Fork this repo
19-
2. Add a failing test demonstrating the problem
20-
-->
21-
Link to your repo:
11+
### Environment
2212

23-
#### Simple self-contained app w/test showing the issue
24-
<!--
25-
1. Create a minimal example that shows the behavior
26-
2. Explain any steps needed to run the test
27-
-->
28-
Link to example:
13+
- [ ] `node -v` output:
14+
- [ ] `npm -v` (or `yarn --version`) output:
15+
- [ ] `npm ls testdouble` (or `yarn list testdouble`) version:
2916

30-
#### Your app w/test showing the issue
3117
<!--
32-
1. Provide your app w/failing test
33-
2. Add instructions on how to reproduce
34-
-->
35-
Link to repo:
18+
The easier you make it for others to reproduce what you're describing, the
19+
sooner it will be addressed. If we can't replicate the described behavior, we
20+
may be forced to close the issue without finding a satisfying resolution.
3621
37-
#### Test example
38-
<!--
39-
1. Provide a concise failing test that shows the unwanted behavior
22+
Below are four approaches you might take to communicate the issue, in
23+
descending order of awesomeness. Please choose one and feel free to delete
24+
the others from this template.
4025
-->
4126

42-
#### Reproduction Steps
43-
<!-- These are usually harder for us to puzzle through, but we'll try to help! -->
27+
### Failing Test
4428

45-
### System configuration
29+
- [ ] Fork the repo
30+
- [ ] Add a failing test (probably to the `/regression/src' directory)
31+
- [ ] Submit a pull request for the failing test or link to your branch here
4632

47-
OS:
48-
Node version:
33+
### Example Repo
34+
35+
- [ ] Create a minimal repository that reproduces the issue
36+
- [ ] Make sure that a fresh clone can run only `npm it` and observe the issue
37+
- [ ] Link to that repo here
38+
39+
#### Runkit Notebook
40+
41+
- [ ] [Create a Runkit notebook](https://runkit.com/new)
42+
- [ ] Invoke `var td = require('testdouble')` at the top
43+
- [ ] Verify the behavior your issue is concerned with by clicking "Run"
44+
- [ ] Link to the Runkit here
45+
46+
#### Code-fenced Examples
47+
48+
<!--
49+
If none of the above approaches are feasible or appropriate, you may use
50+
Markdown code fences (e.g. ```js ……… ```) to demonstrate the behavior here.
51+
Please note that issues submitted with only code-fence examples will be
52+
deprioritized if they prove difficult to reproduce.
53+
-->

0 commit comments

Comments
 (0)