Skip to content

Commit

Permalink
docs: update links and re-add typings section (#700)
Browse files Browse the repository at this point in the history
Co-authored-by: Sam Tsai <satsai@cisco.com>
  • Loading branch information
samtsai and samtsai authored Jun 6, 2020
1 parent 3d9be67 commit 547eef6
Show file tree
Hide file tree
Showing 5 changed files with 12 additions and 7 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ Reproduction repository:
<!--
If possible, please create a repository that reproduces the issue with the
minimal amount of code possible. You may fork the template here:
https://github.com/alexkrolick/dom-testing-library-template
https://github.com/testing-library/dom-testing-library-template
Or if you can, try to reproduce the issue in a codesandbox. You can fork the
one here: https://codesandbox.io/s/5z6x4r7n0p
Expand Down
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/Bug_Report.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ var your => (code) => here;

<!--
If this is an issue with documentation, please file an issue on the docs repo:
https://github.com/alexkrolick/testing-library-docs
https://github.com/testing-library/testing-library-docs
-->

### What you did:
Expand All @@ -63,7 +63,7 @@ https://github.com/alexkrolick/testing-library-docs
If possible, please create a repository that reproduces the issue with the
minimal amount of code possible.
Template repo: https://github.com/alexkrolick/dom-testing-library-template
Template repo: https://github.com/testing-library/dom-testing-library-template
Or if you can, try to reproduce the issue in a Codesandbox. You can fork the one
here: https://codesandbox.io/s/5z6x4r7n0p
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/Question.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,6 @@ codesandbox to make a reproduction of your issue: https://kcd.im/rtl-help
- Reactiflux on Discord https://www.reactiflux.com
- Stack Overflow
https://stackoverflow.com/questions/tagged/react-testing-library
- Documentation: https://github.com/alexkrolick/testing-library-docs
- Documentation: https://github.com/testing-library/testing-library-docs

**ISSUES WHICH ARE QUESTIONS WILL BE CLOSED**
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ merge of your pull request!
<!-- to check an item, place an "x" in the box like so: "- [x] Documentation" -->

- [ ] Documentation added to the
[docs site](https://github.com/alexkrolick/testing-library-docs)
[docs site](https://github.com/testing-library/testing-library-docs)
- [ ] Tests
- [ ] Typescript definitions updated
- [ ] Ready to be merged
Expand Down
9 changes: 7 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,13 @@ sure to include those changes (if they exist) in your commit.
### Update Typings
The TypeScript type definitions are in the
[DefinitelyTyped repo](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/testing-library__react)
If your PR introduced some changes in the API, you are more than welcome to
modify the Typescript type definition to reflect those changes. Just modify the
`/types/index.d.ts` file accordingly. If you have never seen Typescript
definitions before, you can read more about it in its
[documentation pages](https://www.typescriptlang.org/docs/handbook/declaration-files/introduction.html).
Though this library itself is not written in Typescript we use
[dtslint](https://github.com/microsoft/dtslint) to lint our typings.
## Help needed
Expand Down

0 comments on commit 547eef6

Please # to comment.