From cd785432ff88ec775fdd5505ffe0d22a1b4185d2 Mon Sep 17 00:00:00 2001 From: Alex Krolick Date: Thu, 3 May 2018 19:12:40 -0700 Subject: [PATCH 1/5] chore: issue templates --- .github/ISSUE_TEMPLATE/Bug_Report.md | 63 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/Feature_Request.md | 38 ++++++++++++++ .github/ISSUE_TEMPLATE/Question.md | 22 ++++++++ README.md | 8 +-- 4 files changed, 128 insertions(+), 3 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/Bug_Report.md create mode 100644 .github/ISSUE_TEMPLATE/Feature_Request.md create mode 100644 .github/ISSUE_TEMPLATE/Question.md diff --git a/.github/ISSUE_TEMPLATE/Bug_Report.md b/.github/ISSUE_TEMPLATE/Bug_Report.md new file mode 100644 index 00000000..de5aaa11 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/Bug_Report.md @@ -0,0 +1,63 @@ +--- +name: πŸ› Bug Report +about: Bugs, missing documentation, or unexpected behavior πŸ€”. +--- + + + +* `react-testing-library` version: +* `react` version: +* `node` version: +* `npm` (or `yarn`) version: + +### Relevant code or config: + +```js +var your => (code) => here; +``` + +### What you did: + + + +### What happened: + + + +### Reproduction: + + + +### Problem description: + + + +### Suggested solution: + + diff --git a/.github/ISSUE_TEMPLATE/Feature_Request.md b/.github/ISSUE_TEMPLATE/Feature_Request.md new file mode 100644 index 00000000..476e3f48 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/Feature_Request.md @@ -0,0 +1,38 @@ +--- +name: πŸ’‘ Feature Request +about: I have a suggestion (and might want to implement myself πŸ™‚)! +--- + + + +**Describe the feature you'd like** +A clear and concise description of what you want to happen. Add any considered +drawbacks. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've +considered. + +**Teachability, Documentation, Adoption, Migration Strategy** +If you can, explain how users will be able to use this and possibly write out a +version of the docs. diff --git a/.github/ISSUE_TEMPLATE/Question.md b/.github/ISSUE_TEMPLATE/Question.md new file mode 100644 index 00000000..632d51ff --- /dev/null +++ b/.github/ISSUE_TEMPLATE/Question.md @@ -0,0 +1,22 @@ +--- +name: ❓ Support Question +about: πŸ›‘ If you have a question πŸ’¬, please check out our support channels! +--- + +-------------- πŸ‘† Click "Preview"! + +Issues on GitHub are intended to be related to problems with the library itself, +so we recommend not using this medium to ask them here 😁. + +--- + +## ❓ Support Forums + +* React Spectrum + https://spectrum.chat/react-testing-library +* Reactiflux on Discord + https://www.reactiflux.com +* Stack Overflow + https://stackoverflow.com/questions/tagged/react-testing-library + +**ISSUES WHICH ARE QUESTIONS WILL BE CLOSED** diff --git a/README.md b/README.md index bda5c578..e13bfefb 100644 --- a/README.md +++ b/README.md @@ -171,9 +171,9 @@ The containing DOM node of your rendered React Element (rendered using It'd probably be better if you test the component that's doing the prop updating to ensure that the props are being updated correctly (see -[the Guiding Principles section](#guiding-principles)). That said, if you'd -prefer to update the props of a rendered component in your test, this function -can be used to update props of the rendered component. +[the Guiding Principles section](#guiding-principles)). That said, if you'd +prefer to update the props of a rendered component in your test, this function +can be used to update props of the rendered component. ```javascript const {rerender} = render() @@ -752,12 +752,14 @@ 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") | [
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") | [
Johann Hubert Sonntagbauer](https://github.com/johann-sonntagbauer)
[πŸ’»](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") | | [
Maddi Joyce](http://www.maddijoyce.com)
[πŸ’»](https://github.com/kentcdodds/react-testing-library/commits?author=maddijoyce "Code") | + This project follows the [all-contributors][all-contributors] specification. From 94402c8033576e187fd08604ec6badb8abfbfa90 Mon Sep 17 00:00:00 2001 From: Alex Krolick Date: Thu, 3 May 2018 19:35:44 -0700 Subject: [PATCH 2/5] make headings consistent --- .github/ISSUE_TEMPLATE/Feature_Request.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/Feature_Request.md b/.github/ISSUE_TEMPLATE/Feature_Request.md index 476e3f48..bd2fb835 100644 --- a/.github/ISSUE_TEMPLATE/Feature_Request.md +++ b/.github/ISSUE_TEMPLATE/Feature_Request.md @@ -25,14 +25,17 @@ tutorial to learn how: http://kcd.im/pull-request --> -**Describe the feature you'd like** +### Describe the feature you'd like: + A clear and concise description of what you want to happen. Add any considered drawbacks. -**Describe alternatives you've considered** +### Describe alternatives you've considered: + A clear and concise description of any alternative solutions or features you've considered. -**Teachability, Documentation, Adoption, Migration Strategy** +### Teachability, Documentation, Adoption, Migration Strategy: + If you can, explain how users will be able to use this and possibly write out a version of the docs. From 49cab1f8be4de91e60d1ed56d6d9666e4e814a4b Mon Sep 17 00:00:00 2001 From: Alex Krolick Date: Thu, 3 May 2018 19:38:06 -0700 Subject: [PATCH 3/5] use comments --- .github/ISSUE_TEMPLATE/Feature_Request.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/Feature_Request.md b/.github/ISSUE_TEMPLATE/Feature_Request.md index bd2fb835..7b5fee07 100644 --- a/.github/ISSUE_TEMPLATE/Feature_Request.md +++ b/.github/ISSUE_TEMPLATE/Feature_Request.md @@ -27,15 +27,21 @@ tutorial to learn how: http://kcd.im/pull-request ### Describe the feature you'd like: + ### Describe alternatives you've considered: + ### Teachability, Documentation, Adoption, Migration Strategy: + From a3affe2b00b74798b123067f99fd1f52c509068f Mon Sep 17 00:00:00 2001 From: Alex Krolick Date: Thu, 3 May 2018 19:56:43 -0700 Subject: [PATCH 4/5] Update Feature_Request.md --- .github/ISSUE_TEMPLATE/Feature_Request.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/Feature_Request.md b/.github/ISSUE_TEMPLATE/Feature_Request.md index 7b5fee07..5271ca9b 100644 --- a/.github/ISSUE_TEMPLATE/Feature_Request.md +++ b/.github/ISSUE_TEMPLATE/Feature_Request.md @@ -32,6 +32,10 @@ A clear and concise description of what you want to happen. Add any considered drawbacks. --> +### Suggested implementation: + + + ### Describe alternatives you've considered: