From e7f046c72aa0787d918355aae306ce7cd316b147 Mon Sep 17 00:00:00 2001 From: Andy Hanson Date: Tue, 13 Dec 2016 12:37:10 -0800 Subject: [PATCH] Update documentation now that we use the `master` branch instead of `types-2.0` --- PULL_REQUEST_TEMPLATE.md | 2 +- README.md | 21 ++++----------------- 2 files changed, 5 insertions(+), 18 deletions(-) diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md index 78acfdb5c9..7ea40806a1 100644 --- a/PULL_REQUEST_TEMPLATE.md +++ b/PULL_REQUEST_TEMPLATE.md @@ -1,6 +1,6 @@ Please fill in this template. -- [ ] Prefer to make your PR against the `types-2.0` branch. +- [ ] Prefer to 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. - [ ] Follow the advice from the [readme](https://github.com/DefinitelyTyped/DefinitelyTyped#make-a-pull-request). diff --git a/README.md b/README.md index 0b1474cd75..bd97c5b22b 100644 --- a/README.md +++ b/README.md @@ -78,13 +78,7 @@ Once you've tested your definitions with real code, make a PR contributing the d Once you've tested your package, you can share it on DefinitelyTyped. -First, [fork](https://guides.github.com/activities/forking/) this repository. -Then inside your repository: - -* `git checkout types-2.0` - -New work should generally be done on the `types-2.0` branch. -If you want your changes to be available to `typings` users, then you may edit `master` instead. +First, [fork](https://guides.github.com/activities/forking/) this repository, install [node](https://nodejs.org/), and run `npm install`. #### Edit an existing package @@ -121,7 +115,7 @@ You may edit the `tsconfig.json` to add new files or to add the `"jsx"` compiler DefinitelyTyped members routinely monitor for new PRs, though keep in mind that the number of other PRs may slow things down. -For a good example package, see [base64-js](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/types-2.0/base64-js). +For a good example package, see [base64-js](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/base64-js). #### Common mistakes @@ -187,11 +181,9 @@ Test the linter by running `npm run lint -- package-name`. Do not use a globally #### What exactly is the relationship between this repository and the `@types` packages on NPM? -The `types-2.0` branch is automatically published to the `@types` scope on NPM thanks to [types-publisher](https://github.com/Microsoft/types-publisher). +The `master` branch is automatically published to the `@types` scope on NPM thanks to [types-publisher](https://github.com/Microsoft/types-publisher). This usually happens within an hour of changes being merged. -Changes to the `master` branch are also manually merged into the `types-2.0` branch, but this takes longer. - #### I'm writing a definition that depends on another definition. Should I use `` or an import? If the module you're referencing is an external module (uses `export`), use an import. @@ -205,7 +197,7 @@ If you're adding a new major version of a library, you can copy `index.d.ts` to #### I notice some packages having a `package.json` here. Usually you won't need this. When publishing a package we will normally automatically create a `package.json` for it. -A `package.json` may be included for the sake of specifying dependencies. Here's an [example](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/types-2.0/pikaday/package.json). +A `package.json` may be included for the sake of specifying dependencies. Here's an [example](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/pikaday/package.json). We do not allow other fields, such as `"description"`, to be defined manually. Also, if you need to reference an older version of typings, you must do that by adding `"dependencies": { "@types/foo": "x.y.z" }` to the package.json. @@ -213,11 +205,6 @@ Also, if you need to reference an older version of typings, you must do that by Then they are wrong. You can help by submitting a pull request to fix them. -#### Definitions in types-2.0 seem written differently than in master. - -If you're targeting types-2.0, write it like the types-2.0 definitions. -If you're targeting master, we may change it to the new style when merging from master to types-2.0. - #### Can I request a definition? Here are the [currently requested definitions](https://github.com/DefinitelyTyped/DefinitelyTyped/labels/Definition%3ARequest).