From f14833b4cc908c797916d1bcabd975e4813d15e1 Mon Sep 17 00:00:00 2001 From: Andy Hanson Date: Mon, 19 Dec 2016 12:40:13 -0800 Subject: [PATCH 1/2] Clarify pull request template. * 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. --- PULL_REQUEST_TEMPLATE.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md index a14a6df5db..86ec277572 100644 --- a/PULL_REQUEST_TEMPLATE.md +++ b/PULL_REQUEST_TEMPLATE.md @@ -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: <> - [ ] 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`. From eee771c330d7524ccb02b560645e57d32149929b Mon Sep 17 00:00:00 2001 From: Andy Hanson Date: Tue, 27 Dec 2016 12:12:25 -0800 Subject: [PATCH 2/2] Respond to PR comments --- PULL_REQUEST_TEMPLATE.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md index 86ec277572..7e02831b9d 100644 --- a/PULL_REQUEST_TEMPLATE.md +++ b/PULL_REQUEST_TEMPLATE.md @@ -6,19 +6,20 @@ Please fill in this template. - [ ] 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. +- [ ] 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. -- [ ] Create it with `npm run new-package -- foo`, not by basing it on an existing project. +- [ ] Create it with `npm run new-package package-name`, 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: <> - [ ] 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.) +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`.