Skip to content

[README] Replace invalid example links after removing ts3.6 support#55744

Merged
elibarzilay merged 1 commit intoDefinitelyTyped:masterfrom
retyui:update-readme
Sep 13, 2021
Merged

[README] Replace invalid example links after removing ts3.6 support#55744
elibarzilay merged 1 commit intoDefinitelyTyped:masterfrom
retyui:update-readme

Conversation

@retyui
Copy link
Contributor

@retyui retyui commented Sep 13, 2021

Please fill in this template.

Select one of these and delete the others:

If adding a new definition:

  • The package does not already provide its own types, or cannot have its .d.ts files generated via --declaration
  • If this is for an npm package, match the name. If not, do not conflict with the name of an npm package.
  • Create it with dts-gen --dt, not by basing it on an existing project.
  • Represents shape of module/library correctly
  • tslint.json should contain { "extends": "dtslint/dt.json" }, and no additional rules.
  • tsconfig.json should have noImplicitAny, noImplicitThis, strictNullChecks, and strictFunctionTypes set to true.

If changing an existing definition:

  • Provide a URL to documentation or source code which provides context for the suggested changes: <>
  • If this PR brings the type definitions up to date with a new version of the JS library, update the version number in the header.

If removing a declaration:

  • If a package was never on Definitely Typed, you don't need to do anything. (If you wrote a package and provided types, you don't need to register it with us.)
  • Delete the package's directory.
  • Add it to notNeededPackages.json.

@typescript-bot
Copy link
Contributor

typescript-bot commented Sep 13, 2021

@retyui Thank you for submitting this PR!

This is a live comment which I will keep updated.

This PR touches some part of DefinitelyTyped infrastructure, so a DT maintainer will need to review it. This is rare — did you mean to do this?

0 packages in this PR (and infra files)

Code Reviews

There aren't any other owners of this package, so a DT maintainer will review it.

You can test the changes of this PR in the Playground.

Status

Once every item on this list is checked, I'll ask you for permission to merge and publish the changes.


Diagnostic Information: What the bot saw about this PR
{
  "type": "info",
  "now": "-",
  "pr_number": 55744,
  "author": "retyui",
  "headCommitOid": "85b5b501fa8e0ef4ea7a0a162633ba447da758b0",
  "lastPushDate": "2021-09-13T11:31:08.000Z",
  "lastActivityDate": "2021-09-13T20:56:08.000Z",
  "hasMergeConflict": false,
  "isFirstContribution": false,
  "tooManyFiles": false,
  "popularityLevel": "Well-liked by everyone",
  "pkgInfo": [
    {
      "name": null,
      "kind": "edit",
      "files": [
        {
          "path": "README.cn.md",
          "kind": "infrastructure"
        },
        {
          "path": "README.it.md",
          "kind": "infrastructure"
        },
        {
          "path": "README.ja.md",
          "kind": "infrastructure"
        },
        {
          "path": "README.md",
          "kind": "infrastructure"
        },
        {
          "path": "README.pt.md",
          "kind": "infrastructure"
        }
      ],
      "owners": [],
      "addedOwners": [],
      "deletedOwners": [],
      "popularityLevel": "Critical"
    }
  ],
  "reviews": [],
  "mainBotCommentID": 918102604,
  "ciResult": "pass"
}

@typescript-bot
Copy link
Contributor

🔔 @retyui — you're the only owner, but it would still be good if you find someone to review this PR in the next few days, otherwise a maintainer will look at it. (And if you do find someone, maybe even recruit them to be a second owner to make future changes easier...)

@elibarzilay
Copy link
Contributor

@sandersn, @orta, @andrewbranch: I think that using explicit sha1s to avoid referring to files that can get updated is a good idea, but would be good to hear a second opinion...

@orta
Copy link
Collaborator

orta commented Sep 13, 2021

Seems pretty legit to me

@elibarzilay elibarzilay merged commit f039e62 into DefinitelyTyped:master Sep 13, 2021
@sandersn
Copy link
Contributor

I missed this, but 3.6 is no longer supported, so the example should really use a package with ts4.0/ or higher.

@retyui retyui deleted the update-readme branch September 14, 2021 16:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants