From 49cab4bf7d27eb72ebf63335fcd0f5f4476f9338 Mon Sep 17 00:00:00 2001 From: Dominik Lesch Date: Sat, 12 Jun 2021 11:27:00 +0200 Subject: [PATCH 1/2] docs(CONTRIBUTING): update links ... the old egghead.io link redirects to https://app.egghead.io/playlists/how-to-contribute-to-an-open-source-project-on-github which displays "We've got a new version of egghead in BETA. Click here to try it!" remove obsolete all-contributors link (was removed in 29aad25c) --- CONTRIBUTING.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 68e77e6f..d7cdf7e1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -50,6 +50,5 @@ Also, please watch the repo and respond to questions/bug reports/feature requests! Thanks! [egghead]: - https://app.egghead.io/series/how-to-contribute-to-an-open-source-project-on-github -[all-contributors]: https://github.com/all-contributors/all-contributors + https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github [issues]: https://github.com/testing-library/react-testing-library/issues From 9ce1d074dd56c9d425002c1f23fad13d4ea2c88b Mon Sep 17 00:00:00 2001 From: Dominik Lesch Date: Sun, 13 Jun 2021 14:07:29 +0200 Subject: [PATCH 2/2] docs: use consistent spelling for TypeScript ... inspired by https://effectivetypescript.com/2021/02/03/pet-peeves/ --- .github/PULL_REQUEST_TEMPLATE.md | 2 +- CONTRIBUTING.md | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 371a86f6..f5000e21 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -37,7 +37,7 @@ merge of your pull request! - [ ] Documentation added to the [docs site](https://github.com/testing-library/testing-library-docs) - [ ] Tests -- [ ] Typescript definitions updated +- [ ] TypeScript definitions updated - [ ] Ready to be merged diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d7cdf7e1..e16e9d61 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -35,11 +35,11 @@ sure to include those changes (if they exist) in your commit. ### Update Typings 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 +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 +Though this library itself is not written in TypeScript we use [dtslint](https://github.com/microsoft/dtslint) to lint our typings. ## Help needed