Files
DefinitelyTyped/PULL_REQUEST_TEMPLATE.md

1.0 KiB

Please fill in this template.

  • Prefer to make your PR against the types-2.0 branch.
  • Test the change in your own code.
  • Follow the advice from the readme.
  • Avoid common mistakes.
  • Run npm run lint -- package-name if a tslint.json is present.

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.
  • Run tsc without errors.
  • Include the required files and header. Base these on the README, not on an existing project.

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.