From 7074ba53c498006f8f8e9429a81e0e7746dcfdbb Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Adri=C3=A0=20Fontcuberta?= <afontcu@gmail.com>
Date: Sat, 20 Jun 2020 08:38:46 +0200
Subject: [PATCH 1/9] Add links to issues and discord

---
 README.md | 36 +++++++++++++++++++++++++++++++++---
 1 file changed, 33 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index 3d350f0c..5b071491 100644
--- a/README.md
+++ b/README.md
@@ -33,7 +33,6 @@
 [![npm version][npm-badge]][npm]
 
 [![MIT License][license-badge]][license]
-[![Join the community on Spectrum][spectrum-badge]][spectrum]
 <!-- prettier-ignore-end -->
 
 <h2>Table of Contents</h2>
@@ -47,6 +46,10 @@
 - [Docs](#docs)
 - [Typings](#typings)
 - [ESLint support](#eslint-support)
+- [Issues](#issues)
+  - [🐛 Bugs](#-bugs)
+  - [💡 Feature Requests](#-feature-requests)
+  - [❓ Questions](#-questions)
 - [License](#license)
 - [Contributors](#contributors)
 
@@ -145,6 +148,30 @@ bundled with Vue Testing Library.
 If you want to lint test files that use Vue Testing Library, you can use the
 official plugin: [eslint-plugin-testing-library][eslint-plugin-testing-library].
 
+## Issues
+
+_Looking to contribute? Look for the [Good First Issue][good-first-issue]
+label._
+
+### 🐛 Bugs
+
+Please [file an issue][add-issue-bug] for bugs, missing documentation, or
+unexpected behavior.
+
+[**See Bugs**][bugs]
+
+### 💡 Feature Requests
+
+Please [file an issue][add-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 filling an issue on GitHub.
+
+- [Discord][discord]
+
 ## License
 
 [MIT][license]
@@ -178,8 +205,6 @@ official plugin: [eslint-plugin-testing-library][eslint-plugin-testing-library].
 <!-- prettier-ignore-start -->
 [build-badge]: https://travis-ci.org/testing-library/vue-testing-library.svg?branch=master
 [build]: https://travis-ci.org/testing-library/vue-testing-library
-[spectrum-badge]: https://withspectrum.github.io/badge/badge.svg
-[spectrum]: https://spectrum.chat/testing-library
 [coverage-badge]: https://img.shields.io/codecov/c/github/testing-library/vue-testing-library.svg
 [coverage]: https://codecov.io/github/testing-library/vue-testing-library
 [github-badge]: https://badge.fury.io/gh/testing-library%2Fvue-testing-library.svg
@@ -189,11 +214,16 @@ official plugin: [eslint-plugin-testing-library][eslint-plugin-testing-library].
 [license-badge]: https://img.shields.io/github/license/testing-library/vue-testing-library.svg
 [license]: https://github.com/testing-library/vue-testing-library/blob/master/LICENSE
 [types]: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/testing-library__vue
+[discord]: https://testing-library.com/discord
 
 [docs]: https://testing-library.com/vue
 [docs-edit]: https://github.com/testing-library/testing-library-docs
 [eslint-plugin-testing-library]: https://github.com/testing-library/eslint-plugin-testing-library
 
+[bugs]: https://github.com/testing-library/vue-testing-library/issues?q=is%3Aissue+is%3Aopen+label%3Abug+sort%3Acreated-desc
+[add-issue-bug]: https://github.com/testing-library/vue-testing-library/issues/new?assignees=&labels=bug&template=bug_report.md&title=
+[add-issue]: (https://github.com/testing-library/vue-testing-library/issues/new)
+
 [test-directory]: https://github.com/testing-library/vue-testing-library/blob/master/src/__tests__
 [vuex-example]: https://github.com/testing-library/vue-testing-library/blob/master/src/__tests__/vuex.js
 [vue-router-example]: https://github.com/testing-library/vue-testing-library/blob/master/src/__tests__/vue-router.js

From c2a1c9a8bf642fc77fc03790985e821499cce9e7 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Adri=C3=A0=20Fontcuberta?= <afontcu@gmail.com>
Date: Sat, 20 Jun 2020 08:57:38 +0200
Subject: [PATCH 2/9] Improve example to use screen

---
 README.md | 70 ++++++++++++++++++++++++++++++++++++++++++-------------
 1 file changed, 54 insertions(+), 16 deletions(-)

diff --git a/README.md b/README.md
index 5b071491..7e8b2eba 100644
--- a/README.md
+++ b/README.md
@@ -41,8 +41,9 @@
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
 
 - [Installation](#installation)
-- [A simple example](#a-simple-example)
+- [A basic example](#a-basic-example)
   - [More examples](#more-examples)
+- [Guiding Principles](#guiding-principles)
 - [Docs](#docs)
 - [Typings](#typings)
 - [ESLint support](#eslint-support)
@@ -67,10 +68,10 @@ npm install --save-dev @testing-library/vue
 This library has `peerDependencies` listings for `Vue` and
 `vue-template-compiler`.
 
-You may also be interested in installing `jest-dom` so you can use
-[the custom Jest matchers](https://github.com/testing-library/jest-dom#readme).
+You may also be interested in installing `jest-dom` so you can use [the custom
+Jest matchers][jest-dom].
 
-## A simple example
+## A basic example
 
 ```html
 <!-- TestComponent.vue -->
@@ -83,6 +84,7 @@ You may also be interested in installing `jest-dom` so you can use
 
 <script>
   export default {
+    name: 'Button',
     data: () => ({
       count: 0,
     }),
@@ -96,29 +98,42 @@ You may also be interested in installing `jest-dom` so you can use
 ```
 
 ```js
-// TestComponent.spec.js
-import {render, fireEvent} from '@testing-library/vue'
-import TestComponent from './TestComponent.vue'
+import {render, screen, fireEvent} from '@testing-library/vue'
+import Button from './Button'
 
 test('increments value on click', async () => {
-  // The render method returns a collection of utilities to query the component.
-  const {getByText} = render(TestComponent)
+  // The `render` method renders the component into the document.
+  // It also binds to `screen` all the available queries to interact with
+  // the component.
+  render(Button)
 
-  // getByText returns the first matching node for the provided text, and
-  // throws an error if no elements match or if more than one match is found.
-  getByText('Times clicked: 0')
+  // queryByText returns the first matching node for the provided text
+  // or returns null.
+  expect(screen.queryByText('Times clicked: 0')).toBeTruthy()
 
-  // `button` is the actual DOM element.
-  const button = getByText('increment')
+  // getByText returns the first matching node for the provided text
+  // or throws an error.
+  const button = screen.getByText('increment')
 
-  // Dispatch a couple of native click events.
+  // Click a couple of times.
   await fireEvent.click(button)
   await fireEvent.click(button)
 
-  getByText('Times clicked: 2')
+  expect(screen.queryByText('Times clicked: 2')).toBeTruthy()
 })
 ```
 
+> You might want to install jest-dom[jest-dom] to add handy assertions such as
+> `.toBeInTheDocument()`:
+> `expect(screen.queryByText('Times clicked: 0')).toBeInTheDocument()`.
+
+> Using `byText` queries it's not the only nor the best way to query for
+> elements. Read
+> [Which query should I use?](https://testing-library.com/docs/guide-which-query)
+> to discover alternatives. In the example above,
+> `getByRole('button', {name: 'increment'})` is possibly the best option to get
+> the button element.
+
 ### More examples
 
 You'll find examples of testing with different situations and popular libraries
@@ -134,6 +149,27 @@ Some included are:
 
 Feel free to contribute with more examples!
 
+## Guiding Principles
+
+> [The more your tests resemble the way your software is used, the more
+> confidence they can give you.][guiding-principle]
+
+We try to only expose methods and utilities that encourage you to write tests
+that closely resemble how your Vue components are used.
+
+Utilities are included in this project based on the following guiding
+principles:
+
+1.  If it relates to rendering components, it deals with DOM nodes rather than
+    component instances, nor should it encourage dealing with component
+    instances.
+2.  It should be generally useful for testing individual Vue components or
+    full Vue applications.
+3.  Utility implementations and APIs should be simple and flexible.
+
+At the end of the day, what we want is for this library to be pretty
+light-weight, simple, and understandable.
+
 ## Docs
 
 [**Read the docs**][docs] | [Edit the docs][docs-edit]
@@ -215,6 +251,8 @@ instead of filling an issue on GitHub.
 [license]: https://github.com/testing-library/vue-testing-library/blob/master/LICENSE
 [types]: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/testing-library__vue
 [discord]: https://testing-library.com/discord
+[jest-dom]: https://github.com/testing-library/jest-dom
+[guiding-principle]: https://twitter.com/kentcdodds/status/977018512689455106
 
 [docs]: https://testing-library.com/vue
 [docs-edit]: https://github.com/testing-library/testing-library-docs

From 0e34d6c6bcb7b7213f1388ad7890522b5a432875 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Adri=C3=A0=20Fontcuberta?= <afontcu@gmail.com>
Date: Sat, 20 Jun 2020 09:06:02 +0200
Subject: [PATCH 3/9] Remove comment

---
 README.md | 5 ++---
 1 file changed, 2 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index 7e8b2eba..e02835f5 100644
--- a/README.md
+++ b/README.md
@@ -74,7 +74,6 @@ Jest matchers][jest-dom].
 ## A basic example
 
 ```html
-<!-- TestComponent.vue -->
 <template>
   <div>
     <p>Times clicked: {{ count }}</p>
@@ -163,8 +162,8 @@ principles:
 1.  If it relates to rendering components, it deals with DOM nodes rather than
     component instances, nor should it encourage dealing with component
     instances.
-2.  It should be generally useful for testing individual Vue components or
-    full Vue applications.
+2.  It should be generally useful for testing individual Vue components or full
+    Vue applications.
 3.  Utility implementations and APIs should be simple and flexible.
 
 At the end of the day, what we want is for this library to be pretty

From ecc1ba398ff882cc66aafb60fe757aeced2bcfae Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Adri=C3=A0=20Fontcuberta?= <afontcu@gmail.com>
Date: Sat, 20 Jun 2020 09:08:31 +0200
Subject: [PATCH 4/9] Fix links

---
 README.md | 11 +++++------
 1 file changed, 5 insertions(+), 6 deletions(-)

diff --git a/README.md b/README.md
index e02835f5..a7007266 100644
--- a/README.md
+++ b/README.md
@@ -122,16 +122,14 @@ test('increments value on click', async () => {
 })
 ```
 
-> You might want to install jest-dom[jest-dom] to add handy assertions such as
+> You might want to install [jest-dom][jest-dom] to add handy assertions such as
 > `.toBeInTheDocument()`:
 > `expect(screen.queryByText('Times clicked: 0')).toBeInTheDocument()`.
 
 > Using `byText` queries it's not the only nor the best way to query for
-> elements. Read
-> [Which query should I use?](https://testing-library.com/docs/guide-which-query)
-> to discover alternatives. In the example above,
-> `getByRole('button', {name: 'increment'})` is possibly the best option to get
-> the button element.
+> elements. Read [Which query should I use?][which-query] to discover
+> alternatives. In the example above, `getByRole('button', {name: 'increment'})`
+> is possibly the best option to get the button element.
 
 ### More examples
 
@@ -251,6 +249,7 @@ instead of filling an issue on GitHub.
 [types]: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/testing-library__vue
 [discord]: https://testing-library.com/discord
 [jest-dom]: https://github.com/testing-library/jest-dom
+[which-query]: https://testing-library.com/docs/guide-which-query
 [guiding-principle]: https://twitter.com/kentcdodds/status/977018512689455106
 
 [docs]: https://testing-library.com/vue

From da9e64dbe20f59fff0cd0b6ac238ed36de116a20 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Adri=C3=A0=20Fontcuberta?= <afontcu@gmail.com>
Date: Sat, 20 Jun 2020 09:12:13 +0200
Subject: [PATCH 5/9] Fix jest-dom link

---
 README.md | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index a7007266..c48fb867 100644
--- a/README.md
+++ b/README.md
@@ -122,8 +122,8 @@ test('increments value on click', async () => {
 })
 ```
 
-> You might want to install [jest-dom][jest-dom] to add handy assertions such as
-> `.toBeInTheDocument()`:
+> You might want to install [`jest-dom`][jest-dom] to add handy assertions such
+> as `.toBeInTheDocument()`. In the example above, you could write
 > `expect(screen.queryByText('Times clicked: 0')).toBeInTheDocument()`.
 
 > Using `byText` queries it's not the only nor the best way to query for

From e10334bf7173b9c677a70f12c2932a825066913b Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Adri=C3=A0=20Fontcuberta?= <afontcu@gmail.com>
Date: Sat, 20 Jun 2020 09:33:19 +0200
Subject: [PATCH 6/9] filling -> filing

---
 README.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/README.md b/README.md
index c48fb867..0f48a1c0 100644
--- a/README.md
+++ b/README.md
@@ -201,7 +201,7 @@ 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 filling an issue on GitHub.
+instead of filing an issue on GitHub.
 
 - [Discord][discord]
 

From ba3257afb67dd12806c83abc8cb638e67f731e11 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Adri=C3=A0=20Fontcuberta?= <afontcu@gmail.com>
Date: Sun, 21 Jun 2020 12:54:51 +0200
Subject: [PATCH 7/9] Add discord badge

---
 README.md | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 0f48a1c0..00cfce03 100644
--- a/README.md
+++ b/README.md
@@ -31,6 +31,7 @@
 [![Coverage Status][coverage-badge]][coverage]
 [![GitHub version][github-badge]][github]
 [![npm version][npm-badge]][npm]
+[![Discord][discord-badge]][discord]
 
 [![MIT License][license-badge]][license]
 <!-- prettier-ignore-end -->
@@ -246,8 +247,9 @@ instead of filing an issue on GitHub.
 [npm]: https://badge.fury.io/js/%40testing-library%2Fvue
 [license-badge]: https://img.shields.io/github/license/testing-library/vue-testing-library.svg
 [license]: https://github.com/testing-library/vue-testing-library/blob/master/LICENSE
-[types]: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/testing-library__vue
 [discord]: https://testing-library.com/discord
+[discord-badge]: https://img.shields.io/discord/723559267868737556.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2&style=flat-square
+[types]: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/testing-library__vue
 [jest-dom]: https://github.com/testing-library/jest-dom
 [which-query]: https://testing-library.com/docs/guide-which-query
 [guiding-principle]: https://twitter.com/kentcdodds/status/977018512689455106

From 617effb3b97eab459859cc05b4190e33a0aae60c Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Adri=C3=A0=20Fontcuberta?= <afontcu@gmail.com>
Date: Sun, 21 Jun 2020 12:57:20 +0200
Subject: [PATCH 8/9] Swap spectrum with discord

---
 .github/ISSUE_TEMPLATE/bug_report.md | 3 +--
 1 file changed, 1 insertion(+), 2 deletions(-)

diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
index c912f1b8..163f74ac 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -9,8 +9,7 @@ assignees: ''
 <!-- Thanks for your interest in the project. We appreciate bugs filed and PRs submitted! -->
 
 <!--
-- For questions related to using the library, please visit a support community
-  instead of filing an issue on GitHub: https://spectrum.chat/testing-library
+- For questions related to using the library, please [join the Discord server](https://testing-library.com/discord) instead of filing an issue on GitHub.
 
 - Please fill out this template with all the relevant information so we can
   understand what's going on and fix the issue.

From 71620edef1a5a0f9f900ba251b77515da1dda143 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Adri=C3=A0=20Fontcuberta?= <afontcu@gmail.com>
Date: Sun, 21 Jun 2020 23:01:19 +0200
Subject: [PATCH 9/9] Update .github/ISSUE_TEMPLATE/bug_report.md

Co-authored-by: Nick McCurdy <nick@nickmccurdy.com>
---
 .github/ISSUE_TEMPLATE/bug_report.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
index 163f74ac..c031de6d 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -9,7 +9,7 @@ assignees: ''
 <!-- Thanks for your interest in the project. We appreciate bugs filed and PRs submitted! -->
 
 <!--
-- For questions related to using the library, please [join the Discord server](https://testing-library.com/discord) instead of filing an issue on GitHub.
+- For questions related to using the library, please join the Discord server (https://testing-library.com/discord) instead of filing an issue on GitHub.
 
 - Please fill out this template with all the relevant information so we can
   understand what's going on and fix the issue.