Skip to content

Commit 46c3a7e

Browse files
alexkrolickKent C. Dodds
authored and
Kent C. Dodds
committed
chore: document GitHub issues flow (#67)
* chore: document GitHub issues flow * chore: Link to issues policy * chore: update policies, badges * minor updates
1 parent e8fbef5 commit 46c3a7e

File tree

3 files changed

+108
-14
lines changed

3 files changed

+108
-14
lines changed

.all-contributorsrc

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -195,6 +195,18 @@
195195
"contributions": [
196196
"test"
197197
]
198+
},
199+
{
200+
"login": "alexkrolick",
201+
"name": "Alex Krolick",
202+
"avatar_url": "https://avatars3.githubusercontent.com/u/1571667?v=4",
203+
"profile": "https://alexkrolick.com",
204+
"contributions": [
205+
"question",
206+
"doc",
207+
"example",
208+
"ideas"
209+
]
198210
}
199211
]
200212
}

.github/ISSUE_TEMPLATE.md

Lines changed: 50 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,50 @@
11
<!--
2-
HI! PLEASE STOP TO READ THIS!! If you're issue is regarding one of the query
3-
APIs (`getByText`, `getByLabelText`, etc), then please file it on the
4-
`dom-testing-library` repository instead. If you file it here it will be closed.
5-
Thanks :)
62
7-
Thanks for your interest in the project. I appreciate bugs filed and PRs submitted!
8-
Please make sure that you are familiar with and follow the Code of Conduct for
9-
this project (found in the CODE_OF_CONDUCT.md file).
3+
HI! PLEASE STOP TO READ THIS!! IF YOU DO NOT FOLLOW THE INSTRUCTIONS, YOUR ISSUE
4+
WILL LIKELY BE CLOSED.
105
11-
Please fill out this template with all the relevant information so we can
12-
understand what's going on and fix the issue.
6+
Thanks for your interest in the project. We appreciate bugs filed and PRs submitted!
7+
8+
- Please make sure that you are familiar with and follow the Code of Conduct for
9+
this project (found in the CODE_OF_CONDUCT.md file).
10+
11+
- Please review the Issues policies before filing an issue:
12+
13+
🐛 Bugs:
14+
File an issue for bugs, missing documentation, or unexpected behavior.
15+
16+
💡 Feature Requests:
17+
File an issue to suggest new features.
18+
Vote on feature requests by adding a 👍. This helps maintainers prioritize
19+
what to work on.
20+
21+
❓ Questions:
22+
For questions related to using the library, please visit a support community
23+
instead of filing an issue on GitHub.
24+
* React Spectrum
25+
https://spectrum.chat/react-testing-lib
26+
* Reactiflux on Discord
27+
https://www.reactiflux.com
28+
* Stack Overflow
29+
https://stackoverflow.com/questions/tagged/react-testing-library
30+
31+
**ISSUES WHICH ARE QUESTIONS WILL BE CLOSED**
32+
33+
- Please fill out this template with all the relevant information so we can
34+
understand what's going on and fix the issue.
35+
36+
- If you're issue is regarding one of the query APIs (`getByText`,
37+
`getByLabelText`, etc), then please file it on the `dom-testing-library`
38+
repository instead. If you file it here it will be closed. Thanks :)
39+
40+
We'll probably ask you to submit the fix (after giving some direction). If
41+
you've never done that before, that's great! Check this free short video
42+
tutorial to learn how: http://kcd.im/pull-request
1343
14-
I'll probably ask you to submit the fix (after giving some direction). If you've
15-
never done that before, that's great! Check this free short video tutorial to
16-
learn how: http://kcd.im/pull-request
1744
-->
1845

1946
* `react-testing-library` version:
47+
* `react` version:
2048
* `node` version:
2149
* `npm` (or `yarn`) version:
2250

@@ -36,8 +64,18 @@ Reproduction repository:
3664
<!--
3765
If possible, please create a repository that reproduces the issue with the
3866
minimal amount of code possible.
67+
68+
Or if you can, try to reproduce the issue in a codesandbox. You can fork the
69+
one here: https://codesandbox.io/s/5z6x4r7n0p
3970
-->
4071

4172
Problem description:
4273

74+
<!-- Please describe why the current behavior is a problem -->
75+
4376
Suggested solution:
77+
78+
<!--
79+
It's ok if you don't have a suggested solution, but it really helps if you could
80+
do a little digging to come up with some suggestion of how to improve things.
81+
-->

README.md

Lines changed: 46 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,10 @@
1616
[![downloads][downloads-badge]][npmtrends]
1717
[![MIT License][license-badge]][license]
1818

19-
[![All Contributors](https://img.shields.io/badge/all_contributors-19-orange.svg?style=flat-square)](#contributors)
19+
[![All Contributors](https://img.shields.io/badge/all_contributors-20-orange.svg?style=flat-square)](#contributors)
2020
[![PRs Welcome][prs-badge]][prs]
2121
[![Code of Conduct][coc-badge]][coc]
22+
[![Join the community on Spectrum][spectrum-badge]][spectrum]
2223

2324
[![Watch on GitHub][github-watch-badge]][github-watch]
2425
[![Star on GitHub][github-star-badge]][github-star]
@@ -93,6 +94,10 @@ facilitate testing implementation details). Read more about this in
9394
* [Other Solutions](#other-solutions)
9495
* [Guiding Principles](#guiding-principles)
9596
* [Contributors](#contributors)
97+
* [Issues](#issues)
98+
* [🐛 Bugs](#-bugs)
99+
* [💡 Feature Requests](#-feature-requests)
100+
* [❓ Questions](#-questions)
96101
* [LICENSE](#license)
97102

98103
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
@@ -754,20 +759,52 @@ light-weight, simple, and understandable.
754759
Thanks goes to these people ([emoji key][emojis]):
755760

756761
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
762+
757763
<!-- prettier-ignore -->
758764
| [<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") |
759765
| :---: | :---: | :---: | :---: | :---: | :---: | :---: |
760766
| [<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") |
761-
| [<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") |
767+
| [<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") |
768+
762769
<!-- ALL-CONTRIBUTORS-LIST:END -->
763770

764771
This project follows the [all-contributors][all-contributors] specification.
765772
Contributions of any kind welcome!
766773

774+
## Issues
775+
776+
_Looking to contribute? Look for the [Good First Issue][good-first-issue] label._
777+
778+
### 🐛 Bugs
779+
780+
Please file an issue for bugs, missing documentation, or unexpected behavior.
781+
782+
[**See Bugs**][bugs]
783+
784+
### 💡 Feature Requests
785+
786+
Please file an issue to suggest new features. Vote on feature requests by adding
787+
a 👍. This helps maintainers prioritize what to work on.
788+
789+
[**See Feature Requests**][requests]
790+
791+
### ❓ Questions
792+
793+
For questions related to using the library, please visit a support community
794+
instead of filing an issue on GitHub.
795+
796+
* [Spectrum][spectrum]
797+
* [Reactiflux on Discord][reactiflux]
798+
* [Stack Overflow][stackoverflow]
799+
767800
## LICENSE
768801

769802
MIT
770803

804+
<!--
805+
Links:
806+
-->
807+
771808
[npm]: https://www.npmjs.com/
772809
[node]: https://nodejs.org
773810
[build-badge]: https://img.shields.io/travis/kentcdodds/react-testing-library.svg?style=flat-square
@@ -778,6 +815,8 @@ MIT
778815
[package]: https://www.npmjs.com/package/react-testing-library
779816
[downloads-badge]: https://img.shields.io/npm/dm/react-testing-library.svg?style=flat-square
780817
[npmtrends]: http://www.npmtrends.com/react-testing-library
818+
[spectrum-badge]: https://withspectrum.github.io/badge/badge.svg
819+
[spectrum]: https://spectrum.chat/react-testing-lib
781820
[license-badge]: https://img.shields.io/npm/l/react-testing-library.svg?style=flat-square
782821
[license]: https://github.com/kentcdodds/react-testing-library/blob/master/LICENSE
783822
[prs-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square
@@ -796,3 +835,8 @@ MIT
796835
[set-immediate]: https://developer.mozilla.org/en-US/docs/Web/API/Window/setImmediate
797836
[guiding-principle]: https://twitter.com/kentcdodds/status/977018512689455106
798837
[data-testid-blog-post]: https://blog.kentcdodds.com/making-your-ui-tests-resilient-to-change-d37a6ee37269
838+
[bugs]: https://github.com/kentcdodds/react-testing-library/issues?q=is%3Aissue+is%3Aopen+label%3Abug+sort%3Acreated-desc
839+
[requests]: https://github.com/kentcdodds/react-testing-library/issues?q=is%3Aissue+sort%3Areactions-%2B1-desc+label%3Aenhancement+is%3Aopen
840+
[good-first-issue]: https://github.com/kentcdodds/react-testing-library/issues?utf8=✓&q=is%3Aissue+is%3Aopen+sort%3Areactions-%2B1-desc+label%3A"good+first+issue"+
841+
[reactiflux]: https://www.reactiflux.com/
842+
[stackoverflow]: https://stackoverflow.com/questions/tagged/react-testing-library

0 commit comments

Comments
 (0)