Skip to content

docs: add information about TypeScript #272

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

docs: add information about TypeScript #272

wants to merge 1 commit into from

Conversation

SavePointSam
Copy link
Contributor

What:

Added explicit information about TypeScript in the README as well as a note about adding dom to the consumer tsconfig.json.

Why:

Since starting to use TypeScript, I've found it frustrating when packages I use do not have any information about TypeScript in their README as I have to go hunting. I also encountered the configuration issue outlined in the new documentation. It was hard to track down exactly why I was getting errors, so I thought it would be nice to have it right there.

Checklist:

  • Documentation
  • Tests N/A
  • Ready to be merged
  • Added myself to contributors table N/A

Copy link
Collaborator

@alexkrolick alexkrolick left a comment

Choose a reason for hiding this comment

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

Can you also add this to the setup page in the docs, https://github.com/alexkrolick/testing-library-docs 🙏

@kentcdodds
Copy link
Member

Yeah, let's put this in the official docs plz. Thanks!

@kentcdodds kentcdodds closed this Feb 5, 2019
lucbpz pushed a commit to lucbpz/react-testing-library that referenced this pull request Jul 26, 2020
* docs: update README.md

* docs: update .all-contributorsrc

Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants