From 1c8106667d174ded218d62f880750504cdfa7f4e Mon Sep 17 00:00:00 2001 From: Alex Krolick Date: Tue, 1 May 2018 21:21:09 -0700 Subject: [PATCH 1/4] chore: document GitHub issues flow --- .all-contributorsrc | 12 ++++++++++++ README.md | 44 ++++++++++++++++++++++++++++++++++++++++++-- 2 files changed, 54 insertions(+), 2 deletions(-) diff --git a/.all-contributorsrc b/.all-contributorsrc index d2f46602..c7563662 100644 --- a/.all-contributorsrc +++ b/.all-contributorsrc @@ -195,6 +195,18 @@ "contributions": [ "test" ] + }, + { + "login": "alexkrolick", + "name": "Alex Krolick", + "avatar_url": "https://avatars3.githubusercontent.com/u/1571667?v=4", + "profile": "https://alexkrolick.com", + "contributions": [ + "question", + "doc", + "example", + "ideas" + ] } ] } diff --git a/README.md b/README.md index 71e7fe92..2c900f05 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ [![downloads][downloads-badge]][npmtrends] [![MIT License][license-badge]][license] -[![All Contributors](https://img.shields.io/badge/all_contributors-19-orange.svg?style=flat-square)](#contributors) +[![All Contributors](https://img.shields.io/badge/all_contributors-20-orange.svg?style=flat-square)](#contributors) [![PRs Welcome][prs-badge]][prs] [![Code of Conduct][coc-badge]][coc] @@ -93,6 +93,10 @@ facilitate testing implementation details). Read more about this in * [Other Solutions](#other-solutions) * [Guiding Principles](#guiding-principles) * [Contributors](#contributors) +* [Issues](#issues) + * [Bugs](#bugs) + * [Feature Requests](#feature-requests) + * [Questions](#questions) * [LICENSE](#license) @@ -754,20 +758,50 @@ light-weight, simple, and understandable. Thanks goes to these people ([emoji key][emojis]): + | [
Kent C. Dodds](https://kentcdodds.com)
[πŸ’»](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") | [
Ryan Castner](http://audiolion.github.io)
[πŸ“–](https://github.com/kentcdodds/react-testing-library/commits?author=audiolion "Documentation") | [
Daniel Sandiego](https://www.dnlsandiego.com)
[πŸ’»](https://github.com/kentcdodds/react-testing-library/commits?author=dnlsandiego "Code") | [
PaweΕ‚ MikoΕ‚ajczyk](https://github.com/Miklet)
[πŸ’»](https://github.com/kentcdodds/react-testing-library/commits?author=Miklet "Code") | [
Alejandro ÑÑñez Ortiz](http://co.linkedin.com/in/alejandronanez/)
[πŸ“–](https://github.com/kentcdodds/react-testing-library/commits?author=alejandronanez "Documentation") | [
Matt Parrish](https://github.com/pbomb)
[πŸ›](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") | [
Justin Hall](https://github.com/wKovacs64)
[πŸ“¦](#platform-wKovacs64 "Packaging/porting to new platform") | | :---: | :---: | :---: | :---: | :---: | :---: | :---: | | [
Anto Aravinth](https://github.com/antoaravinth)
[πŸ’»](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") | [
Jonah Moses](https://github.com/JonahMoses)
[πŸ“–](https://github.com/kentcdodds/react-testing-library/commits?author=JonahMoses "Documentation") | [
Łukasz Gandecki](http://team.thebrain.pro)
[πŸ’»](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") | [
Ivan Babak](https://sompylasar.github.io)
[πŸ›](https://github.com/kentcdodds/react-testing-library/issues?q=author%3Asompylasar "Bug reports") [πŸ€”](#ideas-sompylasar "Ideas, Planning, & Feedback") | [
Jesse Day](https://github.com/jday3)
[πŸ’»](https://github.com/kentcdodds/react-testing-library/commits?author=jday3 "Code") | [
Ernesto GarcΓ­a](http://gnapse.github.io)
[πŸ’¬](#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") | [
Josef Maxx Blake](http://jomaxx.com)
[πŸ’»](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") | -| [
Michal Baranowski](https://twitter.com/baranovskim)
[πŸ“](#blog-mbaranovski "Blogposts") [βœ…](#tutorial-mbaranovski "Tutorials") | [
Arthur Puthin](https://github.com/aputhin)
[πŸ“–](https://github.com/kentcdodds/react-testing-library/commits?author=aputhin "Documentation") | [
Thomas Chia](https://github.com/thchia)
[πŸ’»](https://github.com/kentcdodds/react-testing-library/commits?author=thchia "Code") [πŸ“–](https://github.com/kentcdodds/react-testing-library/commits?author=thchia "Documentation") | [
Thiago Galvani](http://ilegra.com/)
[πŸ“–](https://github.com/kentcdodds/react-testing-library/commits?author=thiagopaiva99 "Documentation") | [
Christian](http://Chriswcs.github.io)
[⚠️](https://github.com/kentcdodds/react-testing-library/commits?author=ChrisWcs "Tests") | +| [
Michal Baranowski](https://twitter.com/baranovskim)
[πŸ“](#blog-mbaranovski "Blogposts") [βœ…](#tutorial-mbaranovski "Tutorials") | [
Arthur Puthin](https://github.com/aputhin)
[πŸ“–](https://github.com/kentcdodds/react-testing-library/commits?author=aputhin "Documentation") | [
Thomas Chia](https://github.com/thchia)
[πŸ’»](https://github.com/kentcdodds/react-testing-library/commits?author=thchia "Code") [πŸ“–](https://github.com/kentcdodds/react-testing-library/commits?author=thchia "Documentation") | [
Thiago Galvani](http://ilegra.com/)
[πŸ“–](https://github.com/kentcdodds/react-testing-library/commits?author=thiagopaiva99 "Documentation") | [
Christian](http://Chriswcs.github.io)
[⚠️](https://github.com/kentcdodds/react-testing-library/commits?author=ChrisWcs "Tests") | [
Alex Krolick](https://alexkrolick.com)
[πŸ’¬](#question-alexkrolick "Answering Questions") [πŸ“–](https://github.com/kentcdodds/react-testing-library/commits?author=alexkrolick "Documentation") [πŸ’‘](#example-alexkrolick "Examples") [πŸ€”](#ideas-alexkrolick "Ideas, Planning, & Feedback") | + This project follows the [all-contributors][all-contributors] specification. Contributions of any kind welcome! +## Issues + +_Looking to contribute? Look for the [Good First Issue][good-first-issue] label._ + +### Bugs + +Please file an issue for bugs, missing documentation, or unexpected behavior. + +[**See Bugs**][bugs] + +### Feature Requests + +Please file an issue to suggest new features. Vote on feature requests by adding a πŸ‘. This helps maintainers prioritize what to work on. + +[**See Feature Requests**][requests] + +### Questions + +For questions related to using the library, please visit a support community instead of filing an issue on GitHub. + +* [React Spectrum][react-spectrum] +* [Reactiflux on Discord][reactiflux] +* [Stack Overflow][stackoverflow] + ## LICENSE MIT + + [npm]: https://www.npmjs.com/ [node]: https://nodejs.org [build-badge]: https://img.shields.io/travis/kentcdodds/react-testing-library.svg?style=flat-square @@ -796,3 +830,9 @@ MIT [set-immediate]: https://developer.mozilla.org/en-US/docs/Web/API/Window/setImmediate [guiding-principle]: https://twitter.com/kentcdodds/status/977018512689455106 [data-testid-blog-post]: https://blog.kentcdodds.com/making-your-ui-tests-resilient-to-change-d37a6ee37269 +[bugs]: https://github.com/kentcdodds/react-testing-library/issues?q=is%3Aissue+is%3Aopen+label%3Abug+sort%3Acreated-desc +[requests]: https://github.com/kentcdodds/react-testing-library/issues?q=is%3Aissue+sort%3Areactions-%2B1-desc+label%3Aenhancement+is%3Aopen +[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"+ +[react-spectrum]: https://spectrum.chat/react +[reactiflux]: https://www.reactiflux.com/ +[stackoverflow]: https://stackoverflow.com/questions/tagged/react-testing-libary From 681f75d9c680148d9c08c46a319d5e755da8a9ed Mon Sep 17 00:00:00 2001 From: Alex Krolick Date: Wed, 2 May 2018 00:59:32 -0700 Subject: [PATCH 2/4] chore: Link to issues policy --- .github/ISSUE_TEMPLATE.md | 20 ++++++++++++++------ 1 file changed, 14 insertions(+), 6 deletions(-) diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index 115d96e0..15e703e3 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,19 +1,27 @@ * `react-testing-library` version: From 4741a5459e1776e96fa068a4850d25ead9f9530f Mon Sep 17 00:00:00 2001 From: Alex Krolick Date: Wed, 2 May 2018 13:16:35 -0700 Subject: [PATCH 3/4] chore: update policies, badges --- .github/ISSUE_TEMPLATE.md | 21 +++++++++++++++++++-- README.md | 20 +++++++++++--------- 2 files changed, 30 insertions(+), 11 deletions(-) diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index 15e703e3..be6b82da 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -7,8 +7,25 @@ Thanks for your interest in the project. I appreciate bugs filed and PRs submitt - Please make sure that you are familiar with and follow the Code of Conduct for this project (found in the CODE_OF_CONDUCT.md file). -- Please read the Issues policies in the README before filing an issue: - https://github.com/kentcdodds/react-testing-library/blob/master/README.md#issues +- Please review the Issues policies before filing an issue: + + πŸ› Bugs: + File an issue for bugs, missing documentation, or unexpected behavior. + + πŸ’‘ Feature Requests: + File an issue to suggest new features. + Vote on feature requests by adding a πŸ‘. This helps maintainers prioritize + what to work on. + + ❓ Questions: + For questions related to using the library, please visit a support community + instead of filing an issue on GitHub. + * React Spectrum + https://spectrum.chat/react-testing-lib + * Reactiflux on Discord + https://www.reactiflux.com + * Stack Overflow + https://stackoverflow.com/questions/tagged/react-testing-library - Please fill out this template with all the relevant information so we can understand what's going on and fix the issue. diff --git a/README.md b/README.md index 2c900f05..28f3d2a6 100644 --- a/README.md +++ b/README.md @@ -19,6 +19,7 @@ [![All Contributors](https://img.shields.io/badge/all_contributors-20-orange.svg?style=flat-square)](#contributors) [![PRs Welcome][prs-badge]][prs] [![Code of Conduct][coc-badge]][coc] +[![Join the community on Spectrum][spectrum-badge]][spectrum] [![Watch on GitHub][github-watch-badge]][github-watch] [![Star on GitHub][github-star-badge]][github-star] @@ -94,9 +95,9 @@ facilitate testing implementation details). Read more about this in * [Guiding Principles](#guiding-principles) * [Contributors](#contributors) * [Issues](#issues) - * [Bugs](#bugs) - * [Feature Requests](#feature-requests) - * [Questions](#questions) + * [πŸ› Bugs](#-bugs) + * [πŸ’‘ Feature Requests](#-feature-requests) + * [❓ Questions](#-questions) * [LICENSE](#license) @@ -774,23 +775,23 @@ Contributions of any kind welcome! _Looking to contribute? Look for the [Good First Issue][good-first-issue] label._ -### Bugs +### πŸ› Bugs Please file an issue for bugs, missing documentation, or unexpected behavior. [**See Bugs**][bugs] -### Feature Requests +### πŸ’‘ Feature Requests Please file an issue to suggest new features. Vote on feature requests by adding a πŸ‘. This helps maintainers prioritize what to work on. [**See Feature Requests**][requests] -### Questions +### ❓ Questions For questions related to using the library, please visit a support community instead of filing an issue on GitHub. -* [React Spectrum][react-spectrum] +* [Spectrum][spectrum] * [Reactiflux on Discord][reactiflux] * [Stack Overflow][stackoverflow] @@ -812,6 +813,7 @@ Links: [package]: https://www.npmjs.com/package/react-testing-library [downloads-badge]: https://img.shields.io/npm/dm/react-testing-library.svg?style=flat-square [npmtrends]: http://www.npmtrends.com/react-testing-library +[spectrum-badge]: https://withspectrum.github.io/badge/badge.svg [license-badge]: https://img.shields.io/npm/l/react-testing-library.svg?style=flat-square [license]: https://github.com/kentcdodds/react-testing-library/blob/master/LICENSE [prs-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square @@ -833,6 +835,6 @@ Links: [bugs]: https://github.com/kentcdodds/react-testing-library/issues?q=is%3Aissue+is%3Aopen+label%3Abug+sort%3Acreated-desc [requests]: https://github.com/kentcdodds/react-testing-library/issues?q=is%3Aissue+sort%3Areactions-%2B1-desc+label%3Aenhancement+is%3Aopen [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"+ -[react-spectrum]: https://spectrum.chat/react +[spectrum]: https://spectrum.chat/react-testing-lib [reactiflux]: https://www.reactiflux.com/ -[stackoverflow]: https://stackoverflow.com/questions/tagged/react-testing-libary +[stackoverflow]: https://stackoverflow.com/questions/tagged/react-testing-library From 276d9d8d9d1562b8a4092bb06060a682bbcaeba9 Mon Sep 17 00:00:00 2001 From: "Kent C. Dodds" Date: Wed, 2 May 2018 14:24:12 -0600 Subject: [PATCH 4/4] minor updates --- .github/ISSUE_TEMPLATE.md | 35 ++++++++++++++++++++++++----------- README.md | 8 +++++--- 2 files changed, 29 insertions(+), 14 deletions(-) diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index be6b82da..b9a1fdd8 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,11 +1,12 @@ * `react-testing-library` version: +* `react` version: * `node` version: * `npm` (or `yarn`) version: @@ -61,8 +64,18 @@ Reproduction repository: Problem description: + + Suggested solution: + + diff --git a/README.md b/README.md index 28f3d2a6..660b3dab 100644 --- a/README.md +++ b/README.md @@ -783,13 +783,15 @@ Please file an issue for bugs, missing documentation, or unexpected behavior. ### πŸ’‘ Feature Requests -Please file an issue to suggest new features. Vote on feature requests by adding a πŸ‘. This helps maintainers prioritize what to work on. +Please file an issue to suggest new features. Vote on feature requests by adding +a πŸ‘. This helps maintainers prioritize what to work on. [**See Feature Requests**][requests] ### ❓ Questions -For questions related to using the library, please visit a support community instead of filing an issue on GitHub. +For questions related to using the library, please visit a support community +instead of filing an issue on GitHub. * [Spectrum][spectrum] * [Reactiflux on Discord][reactiflux] @@ -814,6 +816,7 @@ Links: [downloads-badge]: https://img.shields.io/npm/dm/react-testing-library.svg?style=flat-square [npmtrends]: http://www.npmtrends.com/react-testing-library [spectrum-badge]: https://withspectrum.github.io/badge/badge.svg +[spectrum]: https://spectrum.chat/react-testing-lib [license-badge]: https://img.shields.io/npm/l/react-testing-library.svg?style=flat-square [license]: https://github.com/kentcdodds/react-testing-library/blob/master/LICENSE [prs-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square @@ -835,6 +838,5 @@ Links: [bugs]: https://github.com/kentcdodds/react-testing-library/issues?q=is%3Aissue+is%3Aopen+label%3Abug+sort%3Acreated-desc [requests]: https://github.com/kentcdodds/react-testing-library/issues?q=is%3Aissue+sort%3Areactions-%2B1-desc+label%3Aenhancement+is%3Aopen [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"+ -[spectrum]: https://spectrum.chat/react-testing-lib [reactiflux]: https://www.reactiflux.com/ [stackoverflow]: https://stackoverflow.com/questions/tagged/react-testing-library