Skip to content

Commit 169a2a8

Browse files
sgravrocksgravrock
committed
Upgraded to new issue templates
1 parent b267029 commit 169a2a8

File tree

5 files changed

+238
-47
lines changed

5 files changed

+238
-47
lines changed

‎.github/ISSUE_TEMPLATE.md

Lines changed: 0 additions & 47 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 109 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,109 @@
1+
name: Bug Report
2+
description: I think I've found a bug in Jasmine
3+
labels: ["unconfirmed bug"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thanks for taking the time to report a bug. Please follow these steps first.
9+
10+
## Troubleshooting
11+
Please take the time to rule out issues with your code or third party libraries before filing a bug report. If you are reporting an error, try to determine whether the error is coming from Jasmine, another library, or your own code.
12+
13+
Check the [FAQ](https://jasmine.github.io/pages/faq.html) and any other relevant [documentation](https://jasmine.github.io/pages/docs_home.html) to see if your issue has already been addressed.
14+
15+
## Special troubleshooting steps for asynchronous scenarios
16+
If the issue has to do with testing asynchronous code, please read the [async tutorial](https://jasmine.github.io/tutorials/async) and the async section of the FAQ. In particular, check for the following common errors:
17+
18+
* Are you trying to write a synchronous test for asynchronous code?
19+
* Does the test signal completion before the code under test finishes?
20+
* Do expectations run before the code that they're trying to verify?
21+
22+
## Try the latest version of Jasmine
23+
If at all possible, upgrade to the latest versions of `jasmine-core` and any other relevant packages (e.g. `jasmine`, `jasmine-browser-runner`). If you can't do that, please check the [release notes](https://github.com/jasmine/jasmine/tree/main/release_notes) for all newer versions to make sure that the bug hasn't already been fixed.
24+
25+
## Put together a [minimal, reproducible example](https://stackoverflow.com/help/minimal-reproducible-example)
26+
Please help us help you by creating a minimal but complete setup that demonstrates the problem. Remove any code and libraries that aren't absolutely necessary, but make sure it doesn't depend on any code you haven't included. In many cases a simple code snippet is enough. In cases involving external libraries, *especially* Karma or Angular, we're likely to need a runable Git repository or jsbin/stackblitz/etc.
27+
28+
**If we can't reproduce it, we can't fix it. Bug reports without a minimal, reproducible example are very likely to be closed.**
29+
30+
- type: textarea
31+
id: steps-to-reproduce
32+
attributes:
33+
label: Steps to Reproduce
34+
placeholder: |
35+
Example steps:
36+
1. Paste the example code below into `mySpec.js`.
37+
2. Run `npx jasmine@<some version> mySpec.js`
38+
validations:
39+
required: true
40+
- type: textarea
41+
id: expected-behavior
42+
attributes:
43+
label: Expected Behavior
44+
description: What do you think should have happened?
45+
validations:
46+
required: true
47+
- type: textarea
48+
id: actual-behavior
49+
attributes:
50+
label: Actual Behavior
51+
description: What happened instead?
52+
validations:
53+
required: true
54+
- type: textarea
55+
id: code-sample
56+
attributes:
57+
label: Example code that reproduces the problem
58+
description: Please include either a code snippet that reproduces the problem or a link to a repository or jsbin/stackblitz/etc containing a minimal, reproducible example as described above.
59+
render: JavaScript
60+
validations:
61+
required: true
62+
- type: textarea
63+
id: possible-solution
64+
attributes:
65+
label: Possible Solution
66+
description: This is optional, but if you have an idea for how to fix the bug we'd like to hear it.
67+
- type: textarea
68+
id: context
69+
attributes:
70+
label: Context
71+
description: How has this issue affected you? What are you trying to accomplish? By providing context, you can help us come up with a solution that is most useful in the real world.
72+
- type: input
73+
id: jasmine-core-version
74+
attributes:
75+
label: jasmine-core version
76+
validations:
77+
required: true
78+
- type: dropdown
79+
id: repro-with-latest-core
80+
attributes:
81+
label: Does the problem occur with the latest version of jasmine-core?
82+
options:
83+
- "Yes"
84+
- "No"
85+
- I haven't tried
86+
- I'm stuck on an older version
87+
validations:
88+
required: true
89+
- type: textarea
90+
id: other-versions
91+
attributes:
92+
label: Versions of other relevant packages
93+
placeholder: |
94+
jasmine-browser-runner 1.2.0
95+
fancy-reporter 132.4.8
96+
- type: input
97+
id: browser-or-node-version
98+
attributes:
99+
label: Node.js or browser version
100+
placeholder: E.g. "node 16.2.0" or "Safari 15"
101+
validations:
102+
required: true
103+
- type: input
104+
id: os
105+
attributes:
106+
label: Operating System
107+
placeholder: E.g. "Windows 10", "MacOS 12.5", "MCC Interim Linux 0.99.p8"
108+
validations:
109+
required: true

‎.github/ISSUE_TEMPLATE/config.yml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Issues with the `jasmine` CLI
4+
url: https://github.com/jasmine/jasmine-npm/issues
5+
about: Please create issues related to the `jasmine` package in its repository.
6+
- name: Issues with jasmine-browser-runner
7+
url: https://github.com/jasmine/jasmine-browser-runner/issues
8+
about: Please create issues related to the `jasmine-browser-runner` package in its repository.
9+
- name: Documentation issues
10+
url: https://github.com/jasmine/jasmine.github.io/issues
11+
about: Please create documentation issues in the docs repository.
12+
- name: TypeScript issues
13+
url: https://github.com/DefinitelyTyped/DefinitelyTyped/discussions
14+
about: Please create issues related to TypeScript compilation errors or other problems with type definitions at DefinitelyTyped.

‎.github/ISSUE_TEMPLATE/feature_proposal.yml

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
name: Feature Proposal
2+
description: I'd like to propose a new feature
3+
labels: ["feature request"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: Thanks for taking the time to propose a new feature. Although Jasmine is mostly feature complete, we're always open to hearing new ideas.
8+
- type: textarea
9+
id: description
10+
attributes:
11+
label: Feature Proposal
12+
validations:
13+
required: true
14+
- type: textarea
15+
id: context
16+
attributes:
17+
label: Context
18+
description: How would this feature be useful to you? What are you trying to accomplish? By providing context, you can help us come up with a solution that is most useful in the real world.
19+
validations:
20+
required: true
21+
- type: textarea
22+
id: example
23+
attributes:
24+
label: Example
25+
description: If you're proposing a new API or something similar, please show an example of how it would be used.
26+
render: JavaScript
27+
- type: textarea
28+
id: other-info
29+
attributes:
30+
label: Other Information
31+
description: Anything else that you think would be helpful.

‎.github/ISSUE_TEMPLATE/support_request.yml

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
name: Question or Support Request
2+
description: I need help using Jasmine
3+
labels: ["question"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Jasmine is supported by volunteers working in their free time. Although we're generally willing to help, we're going to ask you to put in some effort first to help us help you.
9+
10+
## Troubleshooting
11+
Please take the time to rule out problems with your code or third party libraries before opening an issue. If you're running into an error, try to determine whether the error is coming from Jasmine, another library, or your own code.
12+
13+
Check the [FAQ](https://jasmine.github.io/pages/faq.html) and any other relevant [documentation](https://jasmine.github.io/pages/docs_home.html) to see if your question has already been answered. Consider searching [Stack Overflow](https://stackoverflow.com/questions/tagged/jasmine) and past issues in this repository for related questions as well.
14+
15+
## Special troubleshooting steps for asynchronous scenarios
16+
If the issue has to do with testing asynchronous code, please read the [async tutorial](https://jasmine.github.io/tutorials/async) and the async section of the FAQ. In particular, check for the following common errors:
17+
18+
* Are you trying to write a synchronous test for asynchronous code?
19+
* Does the test signal completion before the code under test finishes?
20+
* Do expectations run before the code that they're trying to verify?
21+
22+
## Consider asking Angular questions in an Angular forum
23+
24+
Questions like "how do I test this Angular service" are mostly about Angular, not Jasmine. You'll likely get better responses in an Angular forum. Here's a rule of thumb: If you can't demonstrate the problem without Angular, you probably have an Angular question.
25+
26+
## Try the latest version of Jasmine
27+
If at all possible, upgrade to the latest versions of `jasmine-core` and any other relevant packages (e.g. `jasmine`, `jasmine-browser-runner`).
28+
29+
## Put together a [minimal, reproducible example](https://stackoverflow.com/help/minimal-reproducible-example)
30+
Please help us help you by creating a minimal but complete setup that demonstrates the problem. Remove any code and libraries that aren't absolutely necessary, but make sure it doesn't depend on any code you haven't included. In many cases a simple code snippet is enough. In cases involving external libraries, *especially* Karma or Angular, we're likely to need a runable Git repository or jsbin/stackblitz/etc.
31+
32+
- type: textarea
33+
id: question
34+
attributes:
35+
label: Your question
36+
description: Clearly describe what you'd like help with.
37+
validations:
38+
required: true
39+
- type: textarea
40+
id: code-sample
41+
attributes:
42+
label: Example code that demonstrates the problem
43+
description: Please include either a code snippet that demonstrates the problem or a link to a repository or jsbin/stackblitz/etc containing a minimal, reproducible example as described above.
44+
render: JavaScript
45+
validations:
46+
required: true
47+
- type: input
48+
id: jasmine-core-version
49+
attributes:
50+
label: jasmine-core version
51+
validations:
52+
required: true
53+
- type: dropdown
54+
id: repro-with-latest-core
55+
attributes:
56+
label: Does the problem occur with the latest version of jasmine-core?
57+
options:
58+
- "Yes"
59+
- "No"
60+
- I haven't tried
61+
- I'm stuck on an older version
62+
validations:
63+
required: true
64+
- type: textarea
65+
id: other-versions
66+
attributes:
67+
label: Versions of other relevant packages
68+
placeholder: |
69+
jasmine-browser-runner 1.2.0
70+
fancy-reporter 132.4.8
71+
- type: input
72+
id: browser-or-node-version
73+
attributes:
74+
label: Node.js or browser version
75+
placeholder: E.g. "node 16.2.0" or "Safari 15"
76+
validations:
77+
required: true
78+
- type: input
79+
id: os
80+
attributes:
81+
label: Operating System
82+
placeholder: E.g. "Windows 10", "MacOS 12.5", "MCC Interim Linux 0.99.p8"
83+
validations:
84+
required: true

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy