Skip to content

Commit

Permalink
feat: initial release of scoped package
Browse files Browse the repository at this point in the history
Reference: testing-library/dom-testing-library#260

BREAKING CHANGE: You need to uninstall `jest-dom` and install `@testing-library/jest-dom` instead. Then change your imports from `jest-dom` to `@testing-library/jest-dom`.
  • Loading branch information
Kent C. Dodds committed Jul 8, 2019
1 parent 0d04699 commit f810c8a
Show file tree
Hide file tree
Showing 13 changed files with 255 additions and 193 deletions.
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@ never done that before, that's great! Check this free short video tutorial to
learn how: http://kcd.im/pull-request
-->

* `jest-dom` version:
* `node` version:
* `npm` (or `yarn`) version:
- `@testing-library/jest-dom` version:
- `node` version:
- `npm` (or `yarn`) version:

Relevant code or config

Expand Down
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/Bug_Report.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@ tutorial to learn how: http://kcd.im/pull-request
-->

* `jest-dom` version:
* `node` version:
* `npm` (or `yarn`) version:
- `@testing-library/jest-dom` version:
- `node` version:
- `npm` (or `yarn`) version:

<!--
* `dom-testing-library` version: (if applicable)
Expand Down
9 changes: 3 additions & 6 deletions .github/ISSUE_TEMPLATE/Question.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,8 @@ and feature requests 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/jest-dom
- React Spectrum https://spectrum.chat/react-testing-library
- Reactiflux on Discord https://www.reactiflux.com
- Stack Overflow https://stackoverflow.com/questions/tagged/jest-dom

**ISSUES WHICH ARE QUESTIONS WILL BE CLOSED**
18 changes: 9 additions & 9 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,30 +14,30 @@ Please fill out the information below to expedite the review and (hopefully)
merge of your pull request!
-->


**What**:
<!-- What changes are being made? (What feature/bug is being fixed here?) -->

<!-- What changes are being made? (What feature/bug is being fixed here?) -->

**Why**:
<!-- Why are these changes necessary? -->

<!-- Why are these changes necessary? -->

**How**:
<!-- How were these changes implemented? -->

<!-- How were these changes implemented? -->

**Checklist**:

<!-- Have you done all of these things? -->

<!-- add "N/A" to the end of each line that's irrelevant to your changes -->

<!-- to check an item, place an "x" in the box like so: "- [x] Documentation" -->

* [ ] Documentation
* [ ] Tests
* [ ] Updated Type Definitions
* [ ] Ready to be merged <!-- In your opinion, is this ready to be merged as soon as it's reviewed? -->
* [ ] Added myself to contributors table <!-- this is optional, see the contributing guidelines for instructions -->
- [ ] Documentation
- [ ] Tests
- [ ] Updated Type Definitions
- [ ] Ready to be merged
<!-- In your opinion, is this ready to be merged as soon as it's reviewed? -->

<!-- feel free to add additional comments -->
3 changes: 2 additions & 1 deletion .prettierrc
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,6 @@
"singleQuote": true,
"trailingComma": "all",
"bracketSpacing": false,
"jsxBracketSameLine": false
"jsxBracketSameLine": false,
"proseWrap": "always"
}
5 changes: 3 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# CHANGELOG

The changelog is automatically updated using [semantic-release](https://github.com/semantic-release/semantic-release).
You can see it on the [releases page](../../releases).
The changelog is automatically updated using
[semantic-release](https://github.com/semantic-release/semantic-release). You
can see it on the [releases page](../../releases).
49 changes: 11 additions & 38 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

Thanks for being willing to contribute!

**Working on your first Pull Request?** You can learn how from this _free_ series
[How to Contribute to an Open Source Project on GitHub][egghead]
**Working on your first Pull Request?** You can learn how from this _free_
series [How to Contribute to an Open Source Project on GitHub][egghead]

## Project setup

Expand All @@ -20,45 +20,17 @@ Thanks for being willing to contribute!
> git branch --set-upstream-to=upstream/master master
> ```
>
> This will add the original repository as a "remote" called "upstream,"
> Then fetch the git information from that remote, then set your local `master`
> branch to use the upstream master branch whenever you run `git pull`.
> Then you can make all of your pull request branches based on this `master`
> branch. Whenever you want to update your version of `master`, do a regular
> `git pull`.
## Add yourself as a contributor

This project follows the [all contributors][all-contributors] specification.
To add yourself to the table of contributors on the `README.md`, please use the
automated script as part of your PR:

```console
npm run add-contributor
```

Follow the prompt and commit `.all-contributorsrc` and `README.md` in the PR.
If you've already added yourself to the list and are making
a new type of contribution, you can run it again and select the added
contribution type.
> This will add the original repository as a "remote" called "upstream," Then
> fetch the git information from that remote, then set your local `master`
> branch to use the upstream master branch whenever you run `git pull`. Then you
> can make all of your pull request branches based on this `master` branch.
> Whenever you want to update your version of `master`, do a regular `git pull`.
## Committing and Pushing changes

Please make sure to run the tests before you commit your changes. You can run
`npm run test:update` which will update any snapshots that need updating.
Make sure to include those changes (if they exist) in your commit.

### opt into git hooks

There are git hooks set up with this project that are automatically installed
when you install dependencies. They're really handy, but are turned off by
default (so as to not hinder new contributors). You can opt into these by
creating a file called `.opt-in` at the root of the project and putting this
inside:

```
pre-commit
```
`npm run test:update` which will update any snapshots that need updating. Make
sure to include those changes (if they exist) in your commit.

## Help needed

Expand All @@ -67,6 +39,7 @@ Please checkout the [the open issues][issues]
Also, please watch the repo and respond to questions/bug reports/feature
requests! Thanks!

[egghead]: https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github
[egghead]:
https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github
[all-contributors]: https://github.com/all-contributors/all-contributors
[issues]: https://github.com/testing-library/jest-dom/issues
Loading

1 comment on commit f810c8a

@nagelmodel
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

WoWee...this is a really neato idea you all have!...I think everyone here deserves a NUCKLE SANDWICH from me..

Please sign in to comment.