mirror of
https://github.com/gosticks/DefinitelyTyped.git
synced 2025-10-16 12:05:41 +00:00
The main page of DefinitlyTyped is heavy because of the long list of types. Linking directly to the .md files can help.
1.7 KiB
1.7 KiB
Please fill in this template.
- Make your PR against the
masterbranch. - Use a meaningful title for the pull request. Include the name of the package modified.
- Test the change in your own code. (Compile and run.)
- Follow the advice from the readme.
- Avoid common mistakes.
- Run
tscwithout errors. - Run
npm run lint package-nameif atslint.jsonis present.
Select one of these and delete the others:
If adding a new definition:
- The package does not provide its own types, and you can not add them.
- 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
npm run new-package package-name, not by basing it on an existing project. tslint.jsonshould be present, andtsconfig.jsonshould havenoImplicitAny,noImplicitThis, andstrictNullChecksset totrue.
If changing an existing definition:
- Provide a URL to documentation or source code which provides context for the suggested changes: <>
- Increase the version number in the header if appropriate.
- If you are making substantial changes, consider adding a
tslint.jsoncontaining{ "extends": "../tslint.json" }.
If removing a declaration:
- If a package was never on DefinitelyTyped, 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.