Skip to content

Commit 5356f20

Browse files
alexkrolickKent C. Dodds
authored and
Kent C. Dodds
committed
chore: issue templates (#71)
* chore: issue templates * make headings consistent * use comments * Update Feature_Request.md * Update Question.md
1 parent 0aae0e1 commit 5356f20

File tree

4 files changed

+141
-3
lines changed

4 files changed

+141
-3
lines changed

.github/ISSUE_TEMPLATE/Bug_Report.md

+63
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
---
2+
name: 🐛 Bug Report
3+
about: Bugs, missing documentation, or unexpected behavior 🤔.
4+
---
5+
6+
<!--
7+
8+
* Please fill out this template with all the relevant information so we can
9+
understand what's going on and fix the issue. We appreciate bugs filed and PRs
10+
submitted!
11+
12+
* If you're issue is regarding one of the query APIs (`getByText`
13+
`getByLabelText`, etc), then please file it on the `dom-testing-library`
14+
repository instead. If you file it here it will be closed. Thanks :)
15+
16+
* Please make sure that you are familiar with and follow the Code of Conduct for
17+
this project (found in the CODE_OF_CONDUCT.md file).
18+
19+
We'll probably ask you to submit the fix (after giving some direction). If
20+
you've never done that before, that's great! Check this free short video
21+
tutorial to learn how: http://kcd.im/pull-request
22+
23+
-->
24+
25+
* `react-testing-library` version:
26+
* `react` version:
27+
* `node` version:
28+
* `npm` (or `yarn`) version:
29+
30+
### Relevant code or config:
31+
32+
```js
33+
var your => (code) => here;
34+
```
35+
36+
### What you did:
37+
38+
<!-- What you were doing -->
39+
40+
### What happened:
41+
42+
<!-- Please provide the full error message/screenshots/anything -->
43+
44+
### Reproduction:
45+
46+
<!--
47+
If possible, please create a repository that reproduces the issue with the
48+
minimal amount of code possible.
49+
50+
Or if you can, try to reproduce the issue in a Codesandbox. You can fork the one
51+
here: https://codesandbox.io/s/5z6x4r7n0p
52+
-->
53+
54+
### Problem description:
55+
56+
<!-- Please describe why the current behavior is a problem -->
57+
58+
### Suggested solution:
59+
60+
<!--
61+
It's ok if you don't have a suggested solution, but it really helps if you could
62+
do a little digging to come up with some suggestion of how to improve things.
63+
-->
+51
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
---
2+
name: 💡 Feature Request
3+
about: I have a suggestion (and might want to implement myself 🙂)!
4+
---
5+
6+
<!--
7+
8+
Vote on feature requests by adding a 👍. This helps maintainers prioritize what
9+
to work on.
10+
11+
* Please fill out this template with all the relevant information so we can
12+
understand what's going on and fix the issue. We appreciate bugs filed and PRs
13+
submitted!
14+
15+
* If you're issue is regarding one of the query APIs (`getByText`
16+
`getByLabelText`, etc), then please file it on the `dom-testing-library`
17+
repository instead. If you file it here it will be closed. Thanks :)
18+
19+
* Please make sure that you are familiar with and follow the Code of Conduct for
20+
this project (found in the CODE_OF_CONDUCT.md file).
21+
22+
We'll probably ask you to submit the fix (after giving some direction). If
23+
you've never done that before, that's great! Check this free short video
24+
tutorial to learn how: http://kcd.im/pull-request
25+
26+
-->
27+
28+
### Describe the feature you'd like:
29+
30+
<!--
31+
A clear and concise description of what you want to happen. Add any considered
32+
drawbacks.
33+
-->
34+
35+
### Suggested implementation:
36+
37+
<!-- Helpful but optional 😀 -->
38+
39+
### Describe alternatives you've considered:
40+
41+
<!--
42+
A clear and concise description of any alternative solutions or features you've
43+
considered.
44+
-->
45+
46+
### Teachability, Documentation, Adoption, Migration Strategy:
47+
48+
<!--
49+
If you can, explain how users will be able to use this and possibly write out a
50+
version of the docs.
51+
-->

.github/ISSUE_TEMPLATE/Question.md

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
name: ❓ Support Question
3+
about: 🛑 If you have a question 💬, please check out our support channels!
4+
---
5+
6+
-------------- 👆 Click "Preview"!
7+
8+
Issues on GitHub are intended to be related to problems with the library itself
9+
and feature requests so we recommend not using this medium to ask them here 😁.
10+
11+
---
12+
13+
## ❓ Support Forums
14+
15+
* React Spectrum
16+
https://spectrum.chat/react-testing-library
17+
* Reactiflux on Discord
18+
https://www.reactiflux.com
19+
* Stack Overflow
20+
https://stackoverflow.com/questions/tagged/react-testing-library
21+
22+
**ISSUES WHICH ARE QUESTIONS WILL BE CLOSED**

README.md

+5-3
Original file line numberDiff line numberDiff line change
@@ -171,9 +171,9 @@ The containing DOM node of your rendered React Element (rendered using
171171

172172
It'd probably be better if you test the component that's doing the prop updating
173173
to ensure that the props are being updated correctly (see
174-
[the Guiding Principles section](#guiding-principles)). That said, if you'd
175-
prefer to update the props of a rendered component in your test, this function
176-
can be used to update props of the rendered component.
174+
[the Guiding Principles section](#guiding-principles)). That said, if you'd
175+
prefer to update the props of a rendered component in your test, this function
176+
can be used to update props of the rendered component.
177177

178178
```javascript
179179
const {rerender} = render(<NumberDisplay number={1} />)
@@ -752,12 +752,14 @@ light-weight, simple, and understandable.
752752
Thanks goes to these people ([emoji key][emojis]):
753753

754754
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
755+
755756
<!-- prettier-ignore -->
756757
| [<img src="https://avatars.githubusercontent.com/u/1500684?v=3" width="100px;"/><br /><sub><b>Kent C. Dodds</b></sub>](https://kentcdodds.com)<br />[💻](https://github.com/kentcdodds/react-testing-library/commits?author=kentcdodds "Code") [📖](https://github.com/kentcdodds/react-testing-library/commits?author=kentcdodds "Documentation") [🚇](#infra-kentcdodds "Infrastructure (Hosting, Build-Tools, etc)") [⚠️](https://github.com/kentcdodds/react-testing-library/commits?author=kentcdodds "Tests") | [<img src="https://avatars1.githubusercontent.com/u/2430381?v=4" width="100px;"/><br /><sub><b>Ryan Castner</b></sub>](http://audiolion.github.io)<br />[📖](https://github.com/kentcdodds/react-testing-library/commits?author=audiolion "Documentation") | [<img src="https://avatars0.githubusercontent.com/u/8008023?v=4" width="100px;"/><br /><sub><b>Daniel Sandiego</b></sub>](https://www.dnlsandiego.com)<br />[💻](https://github.com/kentcdodds/react-testing-library/commits?author=dnlsandiego "Code") | [<img src="https://avatars2.githubusercontent.com/u/12592677?v=4" width="100px;"/><br /><sub><b>Paweł Mikołajczyk</b></sub>](https://github.com/Miklet)<br />[💻](https://github.com/kentcdodds/react-testing-library/commits?author=Miklet "Code") | [<img src="https://avatars3.githubusercontent.com/u/464978?v=4" width="100px;"/><br /><sub><b>Alejandro Ñáñez Ortiz</b></sub>](http://co.linkedin.com/in/alejandronanez/)<br />[📖](https://github.com/kentcdodds/react-testing-library/commits?author=alejandronanez "Documentation") | [<img src="https://avatars0.githubusercontent.com/u/1402095?v=4" width="100px;"/><br /><sub><b>Matt Parrish</b></sub>](https://github.com/pbomb)<br />[🐛](https://github.com/kentcdodds/react-testing-library/issues?q=author%3Apbomb "Bug reports") [💻](https://github.com/kentcdodds/react-testing-library/commits?author=pbomb "Code") [📖](https://github.com/kentcdodds/react-testing-library/commits?author=pbomb "Documentation") [⚠️](https://github.com/kentcdodds/react-testing-library/commits?author=pbomb "Tests") | [<img src="https://avatars1.githubusercontent.com/u/1288694?v=4" width="100px;"/><br /><sub><b>Justin Hall</b></sub>](https://github.com/wKovacs64)<br />[📦](#platform-wKovacs64 "Packaging/porting to new platform") |
757758
| :---: | :---: | :---: | :---: | :---: | :---: | :---: |
758759
| [<img src="https://avatars1.githubusercontent.com/u/1241511?s=460&v=4" width="100px;"/><br /><sub><b>Anto Aravinth</b></sub>](https://github.com/antoaravinth)<br />[💻](https://github.com/kentcdodds/react-testing-library/commits?author=antoaravinth "Code") [⚠️](https://github.com/kentcdodds/react-testing-library/commits?author=antoaravinth "Tests") [📖](https://github.com/kentcdodds/react-testing-library/commits?author=antoaravinth "Documentation") | [<img src="https://avatars2.githubusercontent.com/u/3462296?v=4" width="100px;"/><br /><sub><b>Jonah Moses</b></sub>](https://github.com/JonahMoses)<br />[📖](https://github.com/kentcdodds/react-testing-library/commits?author=JonahMoses "Documentation") | [<img src="https://avatars1.githubusercontent.com/u/4002543?v=4" width="100px;"/><br /><sub><b>Łukasz Gandecki</b></sub>](http://team.thebrain.pro)<br />[💻](https://github.com/kentcdodds/react-testing-library/commits?author=lgandecki "Code") [⚠️](https://github.com/kentcdodds/react-testing-library/commits?author=lgandecki "Tests") [📖](https://github.com/kentcdodds/react-testing-library/commits?author=lgandecki "Documentation") | [<img src="https://avatars2.githubusercontent.com/u/498274?v=4" width="100px;"/><br /><sub><b>Ivan Babak</b></sub>](https://sompylasar.github.io)<br />[🐛](https://github.com/kentcdodds/react-testing-library/issues?q=author%3Asompylasar "Bug reports") [🤔](#ideas-sompylasar "Ideas, Planning, & Feedback") | [<img src="https://avatars3.githubusercontent.com/u/4439618?v=4" width="100px;"/><br /><sub><b>Jesse Day</b></sub>](https://github.com/jday3)<br />[💻](https://github.com/kentcdodds/react-testing-library/commits?author=jday3 "Code") | [<img src="https://avatars0.githubusercontent.com/u/15199?v=4" width="100px;"/><br /><sub><b>Ernesto García</b></sub>](http://gnapse.github.io)<br />[💬](#question-gnapse "Answering Questions") [💻](https://github.com/kentcdodds/react-testing-library/commits?author=gnapse "Code") [📖](https://github.com/kentcdodds/react-testing-library/commits?author=gnapse "Documentation") | [<img src="https://avatars2.githubusercontent.com/u/2747424?v=4" width="100px;"/><br /><sub><b>Josef Maxx Blake</b></sub>](http://jomaxx.com)<br />[💻](https://github.com/kentcdodds/react-testing-library/commits?author=jomaxx "Code") [📖](https://github.com/kentcdodds/react-testing-library/commits?author=jomaxx "Documentation") [⚠️](https://github.com/kentcdodds/react-testing-library/commits?author=jomaxx "Tests") |
759760
| [<img src="https://avatars1.githubusercontent.com/u/29602306?v=4" width="100px;"/><br /><sub><b>Michal Baranowski</b></sub>](https://twitter.com/baranovskim)<br />[📝](#blog-mbaranovski "Blogposts") [✅](#tutorial-mbaranovski "Tutorials") | [<img src="https://avatars3.githubusercontent.com/u/13985684?v=4" width="100px;"/><br /><sub><b>Arthur Puthin</b></sub>](https://github.com/aputhin)<br />[📖](https://github.com/kentcdodds/react-testing-library/commits?author=aputhin "Documentation") | [<img src="https://avatars2.githubusercontent.com/u/21194045?v=4" width="100px;"/><br /><sub><b>Thomas Chia</b></sub>](https://github.com/thchia)<br />[💻](https://github.com/kentcdodds/react-testing-library/commits?author=thchia "Code") [📖](https://github.com/kentcdodds/react-testing-library/commits?author=thchia "Documentation") | [<img src="https://avatars3.githubusercontent.com/u/20430611?v=4" width="100px;"/><br /><sub><b>Thiago Galvani</b></sub>](http://ilegra.com/)<br />[📖](https://github.com/kentcdodds/react-testing-library/commits?author=thiagopaiva99 "Documentation") | [<img src="https://avatars1.githubusercontent.com/u/19828824?v=4" width="100px;"/><br /><sub><b>Christian</b></sub>](http://Chriswcs.github.io)<br />[⚠️](https://github.com/kentcdodds/react-testing-library/commits?author=ChrisWcs "Tests") | [<img src="https://avatars3.githubusercontent.com/u/1571667?v=4" width="100px;"/><br /><sub><b>Alex Krolick</b></sub>](https://alexkrolick.com)<br />[💬](#question-alexkrolick "Answering Questions") [📖](https://github.com/kentcdodds/react-testing-library/commits?author=alexkrolick "Documentation") [💡](#example-alexkrolick "Examples") [🤔](#ideas-alexkrolick "Ideas, Planning, & Feedback") | [<img src="https://avatars3.githubusercontent.com/u/1239401?v=4" width="100px;"/><br /><sub><b>Johann Hubert Sonntagbauer</b></sub>](https://github.com/johann-sonntagbauer)<br />[💻](https://github.com/kentcdodds/react-testing-library/commits?author=johann-sonntagbauer "Code") [📖](https://github.com/kentcdodds/react-testing-library/commits?author=johann-sonntagbauer "Documentation") [⚠️](https://github.com/kentcdodds/react-testing-library/commits?author=johann-sonntagbauer "Tests") |
760761
| [<img src="https://avatars2.githubusercontent.com/u/2224291?v=4" width="100px;"/><br /><sub><b>Maddi Joyce</b></sub>](http://www.maddijoyce.com)<br />[💻](https://github.com/kentcdodds/react-testing-library/commits?author=maddijoyce "Code") |
762+
761763
<!-- ALL-CONTRIBUTORS-LIST:END -->
762764

763765
This project follows the [all-contributors][all-contributors] specification.

0 commit comments

Comments
 (0)