vhad/DefinitelyTyped
1
0
Fork 0
mirror of https://github.com/gosticks/DefinitelyTyped.git synced 2026-10-05 23:37:04 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Clarify pull request template.

Browse Source 
* Run `tsc` whether or not it's a new package.
* Compile *and run* the change.
* Change "base on readme" to "npm run new-package"
* Add "If removing a definition:" section.
This commit is contained in:
Andy Hanson
2016-12-19 12:44:58 -08:00
parent 146c4ad615
commit f14833b4cc
1 changed files with 9 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
PULL_REQUEST_TEMPLATE.md
+9 -3
View File
@@ -2,17 +2,23 @@ Please fill in this template.
- [ ] Make your PR against the `master` branch.
- [ ] Use a meaningful title for the pull request. Include the name of the package modified.
- [ ] Test the change in your own code.
- [ ] Test the change in your own code. (Compile and run.)
- [ ] Follow the advice from the [readme](https://github.com/DefinitelyTyped/DefinitelyTyped#make-a-pull-request).
- [ ] Avoid [common mistakes](https://github.com/DefinitelyTyped/DefinitelyTyped#common-mistakes).
- [ ] Run `tsc` without errors.
- [ ] Run `npm run lint -- package-name` if a `tslint.json` is 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.
- [ ] Run `tsc` without errors.
- [ ] Include the required [files](https://github.com/DefinitelyTyped/DefinitelyTyped#create-a-new-package) and header. Base these on the README, *not* on an existing project.
- [ ] Create it with `npm run new-package -- foo`, not by basing it on an existing project.
If changing an existing definition:
- [ ] Provide a URL to documentation or source code which provides context for the suggested changes: <<url here>>
- [ ] Increase the version number in the header if appropriate.
If removing a definition:
- [ ] Delete the package's directory. (If it's not on DefinitelyTyped, you don't need to delete it.)
- [ ] Add it to `notNeededPackages.json`.