From 801edaa0d607e8a5acb988a9ba7777262c5d2df4 Mon Sep 17 00:00:00 2001 From: Dominik Lesch <62334278+leschdom@users.noreply.github.com> Date: Thu, 15 Jul 2021 03:25:14 +0200 Subject: [PATCH] docs(CONTRIBUTING): update links (#932) * 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) * docs: use consistent spelling for TypeScript ... inspired by https://effectivetypescript.com/2021/02/03/pet-peeves/ Co-authored-by: Matan Borenkraout --- .github/PULL_REQUEST_TEMPLATE.md | 2 +- CONTRIBUTING.md | 9 ++++----- 2 files changed, 5 insertions(+), 6 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 68e77e6f..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 @@ -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