diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 5e283ccee0..b009fe3dc1 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -24,6 +24,6 @@ If changing an existing definition: - [ ] If you are making substantial changes, consider adding a `tslint.json` containing `{ "extends": "dtslint/dt.json" }`. If for reason the any rule need to be disabled, disable it for that line using `// tslint:disable-next-line [ruleName]` and not for whole package so that the need for disabling can be reviewed. 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.) +- [ ] If a package was never on Definitely Typed, 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`. diff --git a/README.cn.md b/README.cn.md index 37a5081754..1b140c9fdf 100644 --- a/README.cn.md +++ b/README.cn.md @@ -1,4 +1,4 @@ -# DefinitelyTyped +# Definitely Typed > 这是一个 *高质量* 的 TypeScript 类型定义的仓库。 @@ -29,9 +29,9 @@ * 最近的构建都具有完善的 [类型标注](https://github.com/Microsoft/dtslint)：[![Build Status](https://dev.azure.com/definitelytyped/DefinitelyTyped/_apis/build/status/DefinitelyTyped.DefinitelyTyped?branchName=master)](https://dev.azure.com/definitelytyped/DefinitelyTyped/_build/latest?definitionId=1&branchName=master) * 所有的包基于 typescript@next 版本都有完善的类型标注：[![Build Status](https://dev.azure.com/definitelytyped/DefinitelyTyped/_apis/build/status/DefinitelyTyped.dtslint-runner?branchName=master)](https://dev.azure.com/definitelytyped/DefinitelyTyped/_build/latest?definitionId=2&branchName=master) * 所有的包都会在1小时内 [发布到 npm](https://github.com/Microsoft/types-publisher): [![Publish Status](https://dev.azure.com/definitelytyped/DefinitelyTyped/_apis/build/status/DefinitelyTyped.types-publisher-watchdog?branchName=master)](https://dev.azure.com/definitelytyped/DefinitelyTyped/_build/latest?definitionId=5&branchName=master) -* [typescript-bot](https://github.com/typescript-bot) 在 DefinitelyTyped 一直处于活跃状态 [![Activity Status](https://dev.azure.com/definitelytyped/DefinitelyTyped/_apis/build/status/DefinitelyTyped.typescript-bot-watchdog?branchName=master)](https://dev.azure.com/definitelytyped/DefinitelyTyped/_build/latest?definitionId=6&branchName=master) +* [typescript-bot](https://github.com/typescript-bot) 在 Definitely Typed 一直处于活跃状态 [![Activity Status](https://dev.azure.com/definitelytyped/DefinitelyTyped/_apis/build/status/DefinitelyTyped.typescript-bot-watchdog?branchName=master)](https://dev.azure.com/definitelytyped/DefinitelyTyped/_build/latest?definitionId=6&branchName=master) -如果这里面的任何内容出现问题或者失败的情况，请在 [the DefinitelyTyped Gitter channel](https://gitter.im/DefinitelyTyped/DefinitelyTyped) 提出问题。 +如果这里面的任何内容出现问题或者失败的情况，请在 [the Definitely Typed Gitter channel](https://gitter.im/DefinitelyTyped/DefinitelyTyped) 提出问题。 [![Join the chat at https://gitter.im/DefinitelyTyped/DefinitelyTyped](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/DefinitelyTyped/DefinitelyTyped?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) diff --git a/README.es.md b/README.es.md index 4d57624f14..0e74efaa89 100644 --- a/README.es.md +++ b/README.es.md @@ -1,4 +1,4 @@ -# DefinitelyTyped [![Build Status](https://travis-ci.org/DefinitelyTyped/DefinitelyTyped.svg?branch=master)](https://travis-ci.org/DefinitelyTyped/DefinitelyTyped) +# Definitely Typed [![Build Status](https://travis-ci.org/DefinitelyTyped/DefinitelyTyped.svg?branch=master)](https://travis-ci.org/DefinitelyTyped/DefinitelyTyped) [![Join the chat at https://gitter.im/borisyankov/DefinitelyTyped](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/borisyankov/DefinitelyTyped?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) @@ -77,7 +77,7 @@ Tal vez debas añadir manualmente las [referencias](http://www.typescriptlang.or ## ¿Cómo puedo contribuir? -¡DefinitelyTyped solo trabaja gracias a contribuidores como tú! +¡Definitely Typed solo trabaja gracias a contribuidores como tú! ### Prueba @@ -109,7 +109,7 @@ luego sigue las instrucciones para [editar un paquete existente](#edit-an-existi ### Haz un pull request -Una vez que hayas probado tu paquete, podrás compartirlo en DefinitelyTyped. +Una vez que hayas probado tu paquete, podrás compartirlo en Definitely Typed. Primero, haz un [fork](https://guides.github.com/activities/forking/) en este repositorio, instala [node](https://nodejs.org/), y luego ejecuta la `npm install`. @@ -137,7 +137,7 @@ Si no lo hace, puedes hacerlo en el comentario asociado con el PR. #### Crear un nuevo paquete -Si eres el autor de la librería, o puedes hacer un pull request a la biblioteca, [bundle types](http://www.typescriptlang.org/docs/handbook/declaration-files/publishing.html) en vez de publicarlo en DefinitelyTyped. +Si eres el autor de la librería, o puedes hacer un pull request a la biblioteca, [bundle types](http://www.typescriptlang.org/docs/handbook/declaration-files/publishing.html) en vez de publicarlo en Definitely Typed. Si estás agregando typings para un paquete NPM, crea un directorio con el mismo nombre. Si el paquete al que le estás agregando typings no es para NPM, asegúrate de que el nombre que escojas no genere problemas con el nombre del paquete en NPM. @@ -157,7 +157,7 @@ Ve todas las opciones en [dts-gen](https://github.com/Microsoft/dts-gen). También puedes configurar el `tsconfig.json` para añadir nuevos archivos, para agregar un `"target": "es6"` (necesitado por las funciones asíncronas), para agregar a la `"lib"`, o para agregar la opción de compilación `"jsx"`. -Los miembros de DefinitelyTyped frecuentemente monitorean nuevos PRs, pero ten en mente que la cantidad de PRs podrían ralentizar el proceso. +Los miembros de Definitely Typed frecuentemente monitorean nuevos PRs, pero ten en mente que la cantidad de PRs podrían ralentizar el proceso. Para un buen paquete de ejemplo, vea [base64-js](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/base64-js). @@ -185,7 +185,7 @@ Para un buen paquete de ejemplo, vea [base64-js](https://github.com/DefinitelyTy #### Remover un paquete -Cuando un paquete [bundles](http://www.typescriptlang.org/docs/handbook/declaration-files/publishing.html) sus propios tipos, estos tipos deberán ser removidos de DefinitelyTyped para evitar que generen confusión. +Cuando un paquete [bundles](http://www.typescriptlang.org/docs/handbook/declaration-files/publishing.html) sus propios tipos, estos tipos deberán ser removidos de Definitely Typed para evitar que generen confusión. Se puede remover ejecutando `npm run not-needed -- typingsPackageName asOfVersion sourceRepoURL [libraryName]`. - `typingsPackageName`: Este es el nombre del directorio que tienes que eliminar. @@ -193,9 +193,9 @@ Se puede remover ejecutando `npm run not-needed -- typingsPackageName asOfVersio - `sourceRepoURL`: Esto debería señalar el repositorio que contiene los typings. - `libraryName`: Un nombre descriptivo de la librería, p.ej. "Angular 2" en vez de "angular2". (Si es omitido, será idéntico a "typingsPackageName".) -Cualquier otro paquete en DefinitelyTyped que referencie el paquete eliminado deberá ser actualizado para referenciar los tipos bundled. para hacer esto, añade `package.json` con `"dependencies": { "foo": "x.y.z" }`. +Cualquier otro paquete en Definitely Typed que referencie el paquete eliminado deberá ser actualizado para referenciar los tipos bundled. para hacer esto, añade `package.json` con `"dependencies": { "foo": "x.y.z" }`. -Si un paquete nunca estuvo en DefinitelyTyped, no será necesario añadirlo a `notNeededPackages.json`. +Si un paquete nunca estuvo en Definitely Typed, no será necesario añadirlo a `notNeededPackages.json`. #### Lint @@ -239,7 +239,7 @@ La `master` branch es automáticamente publicada en el alcance de los `@types` #### He enviado un pull request. ¿Cuánto tardará en ser merged? -Esto depende, pero la mayoría de los pull requests serán merged en alrededor de una semana. PRs que hayan sido aprobados por un autor listado en el encabezado de las definiciones usualmente son merged más rápidamente; PRs para nuevas definiciones tomarán más tiempo ya que requieren más revisiones de los mantenedores. Cada PR es revisado por un miembro de TypeScript o DefinitelyTyped antes de ser merged, por favor sé paciente debido a que factores humanos pueden causar retrasos. Revisa el [New Pull Request Status Board](https://github.com/DefinitelyTyped/DefinitelyTyped/projects/5) para ver el progreso mientras los mantenedores trabajan en los PRs abiertos. +Esto depende, pero la mayoría de los pull requests serán merged en alrededor de una semana. PRs que hayan sido aprobados por un autor listado en el encabezado de las definiciones usualmente son merged más rápidamente; PRs para nuevas definiciones tomarán más tiempo ya que requieren más revisiones de los mantenedores. Cada PR es revisado por un miembro de TypeScript o Definitely Typed antes de ser merged, por favor sé paciente debido a que factores humanos pueden causar retrasos. Revisa el [New Pull Request Status Board](https://github.com/DefinitelyTyped/DefinitelyTyped/projects/5) para ver el progreso mientras los mantenedores trabajan en los PRs abiertos. #### Mi PR ha sido merged; ¿cuándo será actualizado el paquete de `@types` NPM? @@ -311,7 +311,7 @@ Por ejemplo [history v2 `tsconfig.json`](https://github.com/DefinitelyTyped/Defi } ``` -Si hay otros paquetes en DefinitelyTyped que son incompatibles con la nueva versión, necesitarás mapear las rutas a la versión anterior. También deberá hacer esto para los paquetes que dependen de paquetes que dependen de una version anterior. +Si hay otros paquetes en Definitely Typed que son incompatibles con la nueva versión, necesitarás mapear las rutas a la versión anterior. También deberá hacer esto para los paquetes que dependen de paquetes que dependen de una version anterior. Por ejemplo, `react-router` depende de `history@2`, así que [react-router `tsconfig.json`](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/types/react-router/tsconfig.json) tiene una ruta mapeada a "history": `[ "history/v2" ]`; transitivo así mismo, `react-router-bootstrap` (que depende de `react-router`) también añade una ruta mapeada en su [tsconfig.json](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/types/react-router-bootstrap/tsconfig.json). diff --git a/README.ko.md b/README.ko.md index 23e3ee6a22..7fe4da8e64 100644 --- a/README.ko.md +++ b/README.ko.md @@ -1,4 +1,4 @@ -# DefinitelyTyped +# Definitely Typed > 이 저장소는 고품질의 타입스크립트(TypeScript) 자료형 정의(Type definition)를 위한 저장소입니다. @@ -28,9 +28,9 @@ * 최신 빌드가 [타입 체크/린트](https://github.com/Microsoft/dtslint) 과정을 깔끔하게 통과했습니다: [![Build Status](https://dev.azure.com/definitelytyped/DefinitelyTyped/_apis/build/status/DefinitelyTyped.DefinitelyTyped?branchName=master)](https://dev.azure.com/definitelytyped/DefinitelyTyped/_build/latest?definitionId=1&branchName=master) * 모든 패키지가 typescript@next상에서 타입 체크/린트 과정을 깔끔하게 통과합니다: [![Build Status](https://dev.azure.com/definitelytyped/DefinitelyTyped/_apis/build/status/DefinitelyTyped.dtslint-runner?branchName=master)](https://dev.azure.com/definitelytyped/DefinitelyTyped/_build/latest?definitionId=2&branchName=master) * 모든 패키지가 1시간 내에 [npm에 배포](https://github.com/microsoft/types-publisher)되었습니다: [![Publish Status](https://dev.azure.com/definitelytyped/DefinitelyTyped/_apis/build/status/DefinitelyTyped.types-publisher-watchdog?branchName=master)](https://dev.azure.com/definitelytyped/DefinitelyTyped/_build/latest?definitionId=5&branchName=master) -* [typescript-bot](https://github.com/typescript-bot)이 DefinitelyTyped에서 잘 돌고 있습니다 [![Activity Status](https://dev.azure.com/definitelytyped/DefinitelyTyped/_apis/build/status/DefinitelyTyped.typescript-bot-watchdog?branchName=master)](https://dev.azure.com/definitelytyped/DefinitelyTyped/_build/latest?definitionId=6&branchName=master) +* [typescript-bot](https://github.com/typescript-bot)이 Definitely Typed에서 잘 돌고 있습니다 [![Activity Status](https://dev.azure.com/definitelytyped/DefinitelyTyped/_apis/build/status/DefinitelyTyped.typescript-bot-watchdog?branchName=master)](https://dev.azure.com/definitelytyped/DefinitelyTyped/_build/latest?definitionId=6&branchName=master) -상태 표시가 비정상이거나 고장 표시가 발생하면 [DefinitelyTyped Gitter 채널](https://gitter.im/DefinitelyTyped/DefinitelyTyped)에서 이 문제를 알려주세요. +상태 표시가 비정상이거나 고장 표시가 발생하면 [Definitely Typed Gitter 채널](https://gitter.im/DefinitelyTyped/DefinitelyTyped)에서 이 문제를 알려주세요. [![https://gitter.im/DefinitelyTyped/DefinitelyTyped 에서 대화에 참여해보세요](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/DefinitelyTyped/DefinitelyTyped?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) @@ -171,7 +171,7 @@ Definitely Typed는 여러분과 같은 많은 기여자들의 도움 덕분에 #### 새 패키지를 만들기 -만약 라이브러리를 만드는 중이고 라이브러리가 타입스크립트(TypeScript)로 쓰여있다면, DefinitelyTyped 에 선언(Declaration)을 올리는 대신 패키지에 [자동생성된 선언(Declaration) 파일을 포함](http://www.typescriptlang.org/docs/handbook/declaration-files/publishing.html)시킬 수 있습니다. +만약 라이브러리를 만드는 중이고 라이브러리가 타입스크립트(TypeScript)로 쓰여있다면, Definitely Typed 에 선언(Declaration)을 올리는 대신 패키지에 [자동생성된 선언(Declaration) 파일을 포함](http://www.typescriptlang.org/docs/handbook/declaration-files/publishing.html)시킬 수 있습니다. NPM 패키지를 위한 자료형(Typing) 패키지를 만드시려면, 패키지의 이름과 같은 이름의 디렉토리를 만들어주세요. NPM 에 올라가 있지 않은 패키지를 위한 자료형(Typing) 패키지를 만드시려면, 그 패키지가 NPM 에 올라와 있는 패키지와 이름이 겹치지 않는지 확인해주세요. @@ -192,7 +192,7 @@ NPM 에 올라가 있지 않은 패키지를 위한 자료형(Typing) 패키지 자료형(Typing) 패키지에 새 파일을 추가하거나, `async` 키워드를 사용하기 위해 `"target"` 을 `"es6"` 로 설정하거나, `"lib"` 를 추가하거나, `jsx` 지원을 추가하기 위해서 `tsconfig.json` 파일을 변경해야 할 수도 있습니다. -DefinitelyTyped 의 관리자들이 주기적으로 새로운 풀 리퀘스트(Pull request)들을 확인하기는 하지만, +Definitely Typed 의 관리자들이 주기적으로 새로운 풀 리퀘스트(Pull request)들을 확인하기는 하지만, 다른 풀 리퀘스트(Pull request)가 많을 경우 확인이 느려질 수 있다는 걸 알아주세요. [base64-js](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/base64-js) 패키지는 좋은 예시 중 하나입니다. @@ -221,7 +221,7 @@ DefinitelyTyped 의 관리자들이 주기적으로 새로운 풀 리퀘스트(P #### 패키지 삭제하기 -패키지가 스스로의 형(Type)을 [포함](http://www.typescriptlang.org/docs/handbook/declaration-files/publishing.html)하게 되면, DefinitelyTyped 에 있는 자료형(Typing) 패키지를 삭제하는 것이 좋습니다. +패키지가 스스로의 형(Type)을 [포함](http://www.typescriptlang.org/docs/handbook/declaration-files/publishing.html)하게 되면, Definitely Typed 에 있는 자료형(Typing) 패키지를 삭제하는 것이 좋습니다. `npm run not-needed -- typingsPackageName asOfVersion sourceRepoURL [libraryName]` 명령어를 사용하여 자료형(Typing) 패키지를 삭제할 수 있습니다. - `typingsPackageName` 는 삭제할 디렉토리의 이름입니다. @@ -229,9 +229,9 @@ DefinitelyTyped 의 관리자들이 주기적으로 새로운 풀 리퀘스트(P - `sourceRepoURL` 는 자료형(Typing)을 포함하게 된 저장소의 주소입니다. - `libraryName` 는 패키지의 이름을 읽기 쉽게 쓴 것입니다. 즉, "angular2" 대신에 "Angular 2" 와 같이 쓰는 것이 좋습니다. (생략했을 경우에는 "typingsPackageName" 와 같은 것으로 취급됩니다.) -DefinitelyTyped 의 다른 패키지들이 삭제된 자료형(Typing) 패키지를 사용하고 있을 경우, 형(Type)을 포함하기 시작한 원래 패키지를 사용하도록 수정해야합니다. 삭제된 자료형(Typing) 패키지를 사용하는 각 DefinitelyTyped 패키지들의 `package.json` 파일에 `"dependencies": { "foo": "x.y.z" }` 를 추가해주시면 됩니다. +Definitely Typed 의 다른 패키지들이 삭제된 자료형(Typing) 패키지를 사용하고 있을 경우, 형(Type)을 포함하기 시작한 원래 패키지를 사용하도록 수정해야합니다. 삭제된 자료형(Typing) 패키지를 사용하는 각 Definitely Typed 패키지들의 `package.json` 파일에 `"dependencies": { "foo": "x.y.z" }` 를 추가해주시면 됩니다. -DefinitelyTyped 에 한 번도 올라온 적 없는 패키지가 형(Type)을 포함하게 되었다면, `notNeededPackages.json` 파일에 추가할 필요도 없습니다. +Definitely Typed 에 한 번도 올라온 적 없는 패키지가 형(Type)을 포함하게 되었다면, `notNeededPackages.json` 파일에 추가할 필요도 없습니다. #### 린터 @@ -278,7 +278,7 @@ f("one"); #### 풀 리퀘스트(Pull request)를 제출했습니다. 이게 합쳐질 때까지 얼마나 걸리나요? -상황에 따라 다르지만, 대부분의 풀 리퀘스트(Pull request)들은 일주일 안에 합쳐집니다. 머릿주석에 있는 저자 중 한명에 의해 승인된 풀 리퀘스트(Pull request)는 보통 더 빨리 합쳐집니다. 새로운 패키지에 대한 풀 리퀘스트(Pull request)는 관리자의 세세한 코드 리뷰를 필요로 하기 때문에 더 오래 걸리는 경우가 많습니다. 각 PR 들은 합쳐지기 전에 TypeScript or DefinitelyTyped 팀 구성원의 코드 리뷰를 받아야 하며, 이는 사람이 하는 일이기 때문에 느려질 수도 있으니 양해를 바랍니다. [풀 리퀘스트 번다운 보드(New Pull Request Status Board)](https://github.com/DefinitelyTyped/DefinitelyTyped/projects/5)에서 열린 풀 리퀘스트에 대한 관리자들의 진행도를 확인하실 수 있습니다. +상황에 따라 다르지만, 대부분의 풀 리퀘스트(Pull request)들은 일주일 안에 합쳐집니다. 머릿주석에 있는 저자 중 한명에 의해 승인된 풀 리퀘스트(Pull request)는 보통 더 빨리 합쳐집니다. 새로운 패키지에 대한 풀 리퀘스트(Pull request)는 관리자의 세세한 코드 리뷰를 필요로 하기 때문에 더 오래 걸리는 경우가 많습니다. 각 PR 들은 합쳐지기 전에 TypeScript or Definitely Typed 팀 구성원의 코드 리뷰를 받아야 하며, 이는 사람이 하는 일이기 때문에 느려질 수도 있으니 양해를 바랍니다. [풀 리퀘스트 번다운 보드(New Pull Request Status Board)](https://github.com/DefinitelyTyped/DefinitelyTyped/projects/5)에서 열린 풀 리퀘스트에 대한 관리자들의 진행도를 확인하실 수 있습니다. #### 내 풀 리퀘스트(Pull request)는 합쳐졌습니다. 언제 NPM 에 `@types` 패키지가 갱신되나요? @@ -324,7 +324,7 @@ NPM 패키지의 경우, `node -p 'require("foo")'` 가 원하는 값이라면 ` [TSJS-Lib-Generator](https://github.com/Microsoft/TSJS-lib-generator#readme) 저장소가 관련되어있을 가능성이 있습니다. 해당 저장소의 안내를 따라주세요. 해당 표준이 아직 초안인 상태라면, 이 저장소와 관련된 일입니다. `dom-` 으로 시작하는 패키지를 만드신 뒤, "Project" 머릿주석 부분에 해당 표준의 링크를 써 주세요. -다만 표준이 초안을 벗어나면 DefinitelyTyped 에서 삭제되고 `@types` 패키지가 지원이 중단된(Deprecated) 것으로 표시될 수도 있습니다. +다만 표준이 초안을 벗어나면 Definitely Typed 에서 삭제되고 `@types` 패키지가 지원이 중단된(Deprecated) 것으로 표시될 수도 있습니다. #### 패키지를 새 메이저 버전(major version)에 맞게 갱신하고 싶어요. @@ -351,12 +351,12 @@ NPM 패키지의 경우, `node -p 'require("foo")'` 가 원하는 값이라면 ` } ``` -수정 중인 패키지에 의존하는 DefinitelyTyped 의 다른 패키지들이 새 버전과 호환되지 않을 경우, 그 패키지들에도 옛날 버전으로의 경로 대응 규칙(Path mapping rule)을 추가해주어야 합니다. 수정 중인 패키지에 의존하는 패키지에 의존하는 패키지들에도 똑같은 작업을 해 주셔야 합니다. +수정 중인 패키지에 의존하는 Definitely Typed 의 다른 패키지들이 새 버전과 호환되지 않을 경우, 그 패키지들에도 옛날 버전으로의 경로 대응 규칙(Path mapping rule)을 추가해주어야 합니다. 수정 중인 패키지에 의존하는 패키지에 의존하는 패키지들에도 똑같은 작업을 해 주셔야 합니다. 예를 들어, `react-router` 패키지는 `history@2` 패키지에 의존하고 있기 때문에, [react-router 패키지의 `tsconfig.json`](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/types/react-router/tsconfig.json) 파일이 `"history": [ "history/v2" ]` 와 같은 경로 대응 규칙(Path mapping rule)을 가지고 있는 걸 볼 수 있습니다. 이어서 (`react-router` 패키지에 의존하는 패키지인) `react-router-bootstrap` 또한 [tsconfig.json](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/types/react-router-bootstrap/tsconfig.json) 파일 안에 경로 대응 규칙(Path mapping rule)을 가지고 있는 것을 보실 수 있습니다. -`/// ` 에서는 경로 대응 규칙(Path mapping rule)이 동작하지 않기 때문에, DefinitelyTyped 패키지로에 의존할 때에는 임포트(import) 를 사용해야 합니다. +`/// ` 에서는 경로 대응 규칙(Path mapping rule)이 동작하지 않기 때문에, Definitely Typed 패키지로에 의존할 때에는 임포트(import) 를 사용해야 합니다. #### 전역적으로도 모듈로도 사용될 수 있는 패키지의 자료형 선언(Type declaration)은 어떻게 쓰나요? diff --git a/README.md b/README.md index da54113e4a..bfb282d3e4 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# DefinitelyTyped +# Definitely Typed > The repository for *high quality* TypeScript type definitions. @@ -28,10 +28,10 @@ It may be helpful for contributors experiencing any issues with their PRs and pa * Most recent build [type-checked/linted](https://github.com/Microsoft/dtslint) cleanly: [![Build Status](https://dev.azure.com/definitelytyped/DefinitelyTyped/_apis/build/status/DefinitelyTyped.DefinitelyTyped?branchName=master)](https://dev.azure.com/definitelytyped/DefinitelyTyped/_build/latest?definitionId=1&branchName=master) * All packages are type-checking/linting cleanly on typescript@next: [![Build Status](https://dev.azure.com/definitelytyped/DefinitelyTyped/_apis/build/status/DefinitelyTyped.dtslint-runner?branchName=master)](https://dev.azure.com/definitelytyped/DefinitelyTyped/_build/latest?definitionId=2&branchName=master) * All packages are being [published to npm](https://github.com/microsoft/types-publisher) in under an hour: [![Publish Status](https://dev.azure.com/definitelytyped/DefinitelyTyped/_apis/build/status/DefinitelyTyped.types-publisher-watchdog?branchName=master)](https://dev.azure.com/definitelytyped/DefinitelyTyped/_build/latest?definitionId=5&branchName=master) -* [typescript-bot](https://github.com/typescript-bot) has been active on DefinitelyTyped [![Activity Status](https://dev.azure.com/definitelytyped/DefinitelyTyped/_apis/build/status/DefinitelyTyped.typescript-bot-watchdog?branchName=master)](https://dev.azure.com/definitelytyped/DefinitelyTyped/_build/latest?definitionId=6&branchName=master) +* [typescript-bot](https://github.com/typescript-bot) has been active on Definitely Typed [![Activity Status](https://dev.azure.com/definitelytyped/DefinitelyTyped/_apis/build/status/DefinitelyTyped.typescript-bot-watchdog?branchName=master)](https://dev.azure.com/definitelytyped/DefinitelyTyped/_build/latest?definitionId=6&branchName=master) * Current [infrastructure status updates](https://github.com/DefinitelyTyped/DefinitelyTyped/issues/44317) -If anything here seems wrong, or any of the above are failing, please raise an issue in [the DefinitelyTyped Gitter channel](https://gitter.im/DefinitelyTyped/DefinitelyTyped). +If anything here seems wrong, or any of the above are failing, please raise an issue in [the Definitely Typed Gitter channel](https://gitter.im/DefinitelyTyped/DefinitelyTyped). [![Join the chat at https://gitter.im/DefinitelyTyped/DefinitelyTyped](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/DefinitelyTyped/DefinitelyTyped?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) @@ -155,16 +155,7 @@ First, [fork](https://guides.github.com/activities/forking/) this repository, in * `cd types/my-package-to-edit` * Make changes. Remember to edit tests. If you make breaking changes, do not forget to [update a major version](#if-a-library-is-updated-to-a-new-major-version-with-breaking-changes-how-should-i-update-its-type-declaration-package). -* You may also want to add yourself to "Definitions by" section of the package header. - - This will cause you to be notified (via your GitHub username) whenever someone makes a pull request or issue about the package. - - Do this by adding your name to the end of the line, as in `// Definitions by: Alice , Bob `. - - Or if there are more people, it can be multiline - ```typescript - // Definitions by: Alice - // Bob - // Steve - // John - ``` + * If there is a `tslint.json`, run `npm run lint package-name`. Otherwise, run `tsc` in the package directory. When you make a PR to edit an existing package, `dt-bot` should @-mention previous authors. @@ -232,6 +223,26 @@ Definitely Typed members routinely monitor for new PRs, though keep in mind that For a good example package, see [base64-js](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/base64-js). +## Definition Owners + +DT has the concept of "Definition Owners" which are people who want to maintain the quality of a particular module's types + + - Adding yourself to the list will cause you to be notified (via your GitHub username) whenever someone makes a pull request or issue about the package. + - Your PR reviews will have a higher precedence of importance to [the bot](https://github.com/DefinitelyTyped/dt-mergebot) which maintains this repo. + - The DT maintainers are putting trust in the definition owners to ensure a stable eco-system, please don't add yourself lightly. + + To Add yourself as a Definition Owner: + + - Adding your name to the end of the line, as in `// Definitions by: Alice , Bob `. + - Or if there are more people, it can be multiline + ```typescript + // Definitions by: Alice + // Bob + // Steve + // John + ``` + +Once a week the Definition Owners are synced to the file [.github/CODEOWNERS](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/.github/CODEOWNERS) which is our source of truth. #### Common mistakes @@ -336,7 +347,13 @@ The `master` branch is automatically published to the `@types` scope on NPM than #### I've submitted a pull request. How long until it is merged? -It depends, but most pull requests will be merged within a week. PRs that have been approved by an author listed in the definition's header are usually merged more quickly; PRs for new definitions will take more time as they require more review from maintainers. Each PR is reviewed by a TypeScript or Definitely Typed team member before being merged, so please be patient as human factors may cause delays. Check the [New Pull Request Status Board](https://github.com/DefinitelyTyped/DefinitelyTyped/projects/5) to see progress as maintainers work through the open PRs. +It depends, but most pull requests will be merged within a week. +Some PRs can be merged by the owners of a module, and they can be merged much faster. +Roughly: + +> PRs which only change the types of a module, and have corresponding tests changes will be merged much faster + +PRs that have been approved by an author listed in the definition's header are usually merged more quickly; PRs for new definitions will take more time as they require more review from maintainers. Each PR is reviewed by a TypeScript or Definitely Typed team member before being merged, so please be patient as human factors may cause delays. Check the [New Pull Request Status Board](https://github.com/DefinitelyTyped/DefinitelyTyped/projects/5) to see progress as maintainers work through the open PRs. #### My PR is merged; when will the `@types` NPM package be updated? @@ -350,7 +367,7 @@ If the module you're referencing is an ambient module (uses `declare module`, or #### I notice some packages having a `package.json` here. Usually you won't need this. -Definitely Typed's package publisher creates a `package.json` for packages with no dependencies outside Definitely Typed. +DefinitelyTyped's package publisher creates a `package.json` for packages with no dependencies outside Definitely Typed. A `package.json` may be included to specify dependencies that are not other `@types` packages. [Pikaday is a good example.](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/types/pikaday/package.json) Even if you write your own `package.json`, you can only specify dependencies; other fields such as `"description"` are not allowed. @@ -362,7 +379,7 @@ Be sure to explain this when adding to the list of allowed packages so that the #### Some packages have no `tslint.json`, and some `tsconfig.json` are missing `"noImplicitAny": true`, `"noImplicitThis": true`, or `"strictNullChecks": true`. -Then they are wrong. You can help by submitting a pull request to fix them. +Then they are wrong, and we've not noticed yet. You can help by submitting a pull request to fix them. #### Can I request a definition? diff --git a/README.ru.md b/README.ru.md index 11a3336c41..e44f177847 100644 --- a/README.ru.md +++ b/README.ru.md @@ -1,4 +1,4 @@ -# DefinitelyTyped +# Definitely Typed > Репозиторий для _высококачественных_ определений типов TypeScript. @@ -36,7 +36,7 @@ _Вы также можете прочитать этот README на [англ - Самая последняя сборка [прошла проверку-типов/линтинг](https://github.com/Microsoft/dtslint) полностью: [![Статус сборки](https://dev.azure.com/definitelytyped/DefinitelyTyped/_apis/build/status/DefinitelyTyped.DefinitelyTyped?branchName=master)](https://dev.azure.com/definitelytyped/DefinitelyTyped/_build/latest?definitionId=1&branchName=master) - Все пакеты проходят проверку-типов/линтинг полностью на `typescript@next`: [![Статус сборки](https://dev.azure.com/definitelytyped/DefinitelyTyped/_apis/build/status/DefinitelyTyped.dtslint-runner?branchName=master)](https://dev.azure.com/definitelytyped/DefinitelyTyped/_build/latest?definitionId=2&branchName=master) - Все пакеты [публикуются на npm](https://github.com/Microsoft/types-publisher) в течении часа: [![Статус публикации](https://dev.azure.com/definitelytyped/DefinitelyTyped/_apis/build/status/DefinitelyTyped.types-publisher-watchdog?branchName=master)](https://dev.azure.com/definitelytyped/DefinitelyTyped/_build/latest?definitionId=5&branchName=master) -- [typescript-bot](https://github.com/typescript-bot) проявляет активность на DefinitelyTyped [![Статус активности](https://dev.azure.com/definitelytyped/DefinitelyTyped/_apis/build/status/DefinitelyTyped.typescript-bot-watchdog?branchName=master)](https://dev.azure.com/definitelytyped/DefinitelyTyped/_build/latest?definitionId=6&branchName=master) +- [typescript-bot](https://github.com/typescript-bot) проявляет активность на Definitely Typed [![Статус активности](https://dev.azure.com/definitelytyped/DefinitelyTyped/_apis/build/status/DefinitelyTyped.typescript-bot-watchdog?branchName=master)](https://dev.azure.com/definitelytyped/DefinitelyTyped/_build/latest?definitionId=6&branchName=master) Если что-то здесь кажется неправильным или что-либо из вышеперечисленного не работает, пожалуйста, поднимите проблему на [канале DefiniteTyped Gitter](https://gitter.im/DefinitelyTyped/DefinitelyTyped). @@ -117,7 +117,7 @@ npm install --save-dev @types/node ## Как я могу внести свой вклад? -DefinitelyTyped работает только благодаря вкладу таких пользователей, как вы! +Definitely Typed работает только благодаря вкладу таких пользователей, как вы! ### Тестирование @@ -147,7 +147,7 @@ DefinitelyTyped работает только благодаря вкладу т ### Запрос на принятие изменений (PR) -После того, как вы проверили ваш пакет, вы можете поделиться им с DefinitelyTyped. +После того, как вы проверили ваш пакет, вы можете поделиться им с Definitely Typed. Во-первых, [разветвите](https://guides.github.com/activities/forking/) этот репозиторий, установите [node](https://nodejs.org/), и запустите `npm install`. @@ -176,7 +176,7 @@ DefinitelyTyped работает только благодаря вкладу т #### Создание нового пакета -Если вы являетесь автором библиотеки и ваш пакет написан на TypeScript, [свяжите автоматически сгенерированные файлы объявлений](https://www.typescriptlang.org/docs/handbook/declaration-files/publishing.html) в вашем пакете, а не публикуйте в DefinitelyTyped. +Если вы являетесь автором библиотеки и ваш пакет написан на TypeScript, [свяжите автоматически сгенерированные файлы объявлений](https://www.typescriptlang.org/docs/handbook/declaration-files/publishing.html) в вашем пакете, а не публикуйте в Definitely Typed. Если вы добавляете типизацию для пакета NPM, создайте директорию с тем же именем. Если пакет, для которого вы добавляете типизацию, отсутствует в NPM, убедитесь, что выбранное вами имя не конфликтует с именем пакета в NPM. @@ -196,7 +196,7 @@ DefinitelyTyped работает только благодаря вкладу т Вы можете отредактировать `tsconfig.json` чтобы добавить новые файлы, добавить `"target": "es6"` (необходимо для асинхронных функций), добавить в `"lib"`, или добавить опцию компилятора `"jsx"`. -Члены группы DefinitelyTyped регулярно следят за новыми PR, но имейте в виду, что количество других PR может замедлить ход событий. +Члены группы Definitely Typed регулярно следят за новыми PR, но имейте в виду, что количество других PR может замедлить ход событий. Хороший пример пакета смотрите [base64-js](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/base64-js). @@ -222,7 +222,7 @@ DefinitelyTyped работает только благодаря вкладу т #### Удаление пакета -Когда пакет [объединяет](https://www.typescriptlang.org/docs/handbook/declaration-files/publishing.html) свои собственные типы, типы должны быть удалены из DefinitelyTyped чтобы избежать путаницы. +Когда пакет [объединяет](https://www.typescriptlang.org/docs/handbook/declaration-files/publishing.html) свои собственные типы, типы должны быть удалены из Definitely Typed чтобы избежать путаницы. Вы можете удалить его, запустив `npm run not-needed -- typingsPackageName asOfVersion sourceRepoURL [libraryName]`. @@ -231,9 +231,9 @@ DefinitelyTyped работает только благодаря вкладу т - `sourceRepoURL`: Это должно указывать на репозиторий, который содержит типизации. - `libraryName`: описательное имя библиотеки, например, "Angular 2" вместо "angular2". (Если опущено, будет идентично "typingsPackageName".) -Любые другие пакеты в DefinitelyTyped которые ссылаются на удаленный пакет, должны быть обновлены для ссылки на связанные типы. Для этого добавьте в `package.json` ссыклу `"dependencies": { "foo": "x.y.z" }`. +Любые другие пакеты в Definitely Typed которые ссылаются на удаленный пакет, должны быть обновлены для ссылки на связанные типы. Для этого добавьте в `package.json` ссыклу `"dependencies": { "foo": "x.y.z" }`. -Если пакет никогда не был в DefinitelyTyped, его не нужно добавлять в `notNeededPackages.json`. +Если пакет никогда не был в Definitely Typed, его не нужно добавлять в `notNeededPackages.json`. #### Linter @@ -285,7 +285,7 @@ f('one'); #### Я отправил PR. Когда он сольется? -Это зависит, но большинство запросов на получение данных будут объединены в течение недели. PR, утвержденные автором, указанным в заголовке определения, обычно объединяются быстрее; PR для новых определений займет больше времени, так как они требуют большего количества проверок от сопровождающих. Каждый PR проверяется членом команды TypeScript или DefinitelyTyped перед объединением, поэтому будьте терпеливы, так как человеческий фактор может вызвать задержки. Посмотрите на [New Pull Request Status Board](https://github.com/DefinitelyTyped/DefinitelyTyped/projects/5) чтобы увидеть, как сопровождающие работают через открытые PR. +Это зависит, но большинство запросов на получение данных будут объединены в течение недели. PR, утвержденные автором, указанным в заголовке определения, обычно объединяются быстрее; PR для новых определений займет больше времени, так как они требуют большего количества проверок от сопровождающих. Каждый PR проверяется членом команды TypeScript или Definitely Typed перед объединением, поэтому будьте терпеливы, так как человеческий фактор может вызвать задержки. Посмотрите на [New Pull Request Status Board](https://github.com/DefinitelyTyped/DefinitelyTyped/projects/5) чтобы увидеть, как сопровождающие работают через открытые PR. #### Мой PR слит; когда будет обновлен пакет `@types` NPM? @@ -331,7 +331,7 @@ f('one'); Это может принадлежать [TSJS-Lib-Generator](https://github.com/Microsoft/TSJS-lib-generator#readme). Смотрите инструкции там. Если стандарт все еще является черновиком, добавляйте сюда. Используйте имя, начинающееся с `dom-` и включите ссылку на стандарт в качестве ссылки "Project" в заголовке. -Когда он завершает черновой режим, мы можем удалить его из DefinitelyTyped и объявить устаревшим связанный пакет `@types`. +Когда он завершает черновой режим, мы можем удалить его из Definitely Typed и объявить устаревшим связанный пакет `@types`. #### Я хочу обновить пакет новой старшей версии @@ -355,7 +355,7 @@ f('one'); } ``` -Если в DefinitelyTyped есть другие пакеты, несовместимые с новой версией, вам нужно будет добавить сопоставления путей к старой версии. Вам также нужно будет сделать это для пакетов в зависимости от пакетов в зависимости от старой версии. +Если в Definitely Typed есть другие пакеты, несовместимые с новой версией, вам нужно будет добавить сопоставления путей к старой версии. Вам также нужно будет сделать это для пакетов в зависимости от пакетов в зависимости от старой версии. Например, `react-router` зависит от `history@2`, поэтому [react-router `tsconfig.json`](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/types/react-router/tsconfig.json) есть сопоставление пути с `"history": [ "history/v2" ]`; транзитивно `react-router-bootstrap` (который зависит от `react-router`) также добавляет отображение пути в свой [tsconfig.json](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/types/react-router-bootstrap/tsconfig.json). diff --git a/docs/admin.md b/docs/admin.md index 3c862d773e..87225349e2 100644 --- a/docs/admin.md +++ b/docs/admin.md @@ -1,19 +1,19 @@ ## Admin Manual for Definitely Typed -Welcome! This is a resource for the person who is on call for DefinitelyTyped. The TypeScript team always has someone -assigned to DefinitelyTyped duty, where they do a week on-call. You can see the [schedule here](http://aka.ms/DTRotation). +Welcome! This is a resource for the person who is on call for Definitely Typed. The TypeScript team always has someone +assigned to Definitely Typed duty, where they do a week on-call. You can see the [schedule here](http://aka.ms/DTRotation). -When on-call, your goal is to try keep on top of the many open PRs for DefinitelyTyped; they are categorized into +When on-call, your goal is to try keep on top of the many open PRs for Definitely Typed; they are categorized into different sections inside the [Projects board](https://github.com/DefinitelyTyped/DefinitelyTyped/projects/4) on this repo. -You should scan from left to right through the boards, and ideally try to start at the oldest PR in a section and work +You should scan from left to right through the boards, and ideally try to start at the oldest PR in a section and work your way through to the newest. There is a tool: [`focus-dt`](https://github.com/DefinitelyTyped/focus-dt) which can help with this. -Our goals are to provide a stable, high quality ecosystem of type definitions and that requires the compiler team +Our goals are to provide a stable, high quality ecosystem of type definitions and that requires the compiler team making sure that a PR does not break the ecosystem. This work isn't a code review in the usual sense, but an assessment -of how well the changes fit the rest of the type definitions and if it could break builds for our users or our systems. -With the impact understood, your job is to delegate to the people who actually know how to review the code: users -of the library who have agreed to look after the types. +of how well the changes fit the rest of the type definitions and if it could break builds for our users or our systems. +With the impact understood, your job is to delegate to the people who actually know how to review the code: users +of the library who have agreed to look after the types. ### Looking at a PR @@ -24,7 +24,7 @@ Some key concepts: - Popular packages can break more installs, and will need more time and focus - There are a handful of authors who have shipped a lot of high quality contributions who you can happily delegate to -##### Amending an existing DefinitelyTyped Package +##### Amending an existing Definitely Typed Package An ideal PR to a DT package looks like: @@ -32,13 +32,13 @@ An ideal PR to a DT package looks like: - Only additions to the existing types - Test code which covers the existing use case -Most of the PRs are like this, in which case then a review for that PR should be pretty quick. Look through the code -changes, then see if there are comments asking for the merge to be delayed. If not, then you're good to merge. You +Most of the PRs are like this, in which case then a review for that PR should be pretty quick. Look through the code +changes, then see if there are comments asking for the merge to be delayed. If not, then you're good to merge. You can then leave a thanks comment and hit the merge button. Constraints which you should consider: -- Will the PR break existing code? +- Will the PR break existing code? - This can sometimes be hard to decipher from the diff, e.g. an additional only PR may break superclasses of a class - We try to make sure that types are a semver match on `major.min` for the library they represent - A build breaking change therefore can be a trade-off where you have to talk with the library maintainer, and get their sign-offs that it is worth it @@ -49,14 +49,14 @@ Constraints which you should consider: - The `tslint.json` does not have exceptions to the rules in it - Strict mode is `strict: true` or equivalent four (five?) settings in tsconfig.json - Make sure export default is actually default in the source. - + ```ts // Cannot have `export default` in the dts module.exports = { thing: () => "hello world" } ``` - + vs ```ts @@ -70,7 +70,7 @@ Constraints which you should consider: - Their `tsconfig.json` should never have `esModuleInterop: true`, which would hide the above issue. -##### New DefinitelyTyped Package +##### New Definitely Typed Package - Is the author also a maintainer of the library? If so, they could use [`--declaration` and `--allowJs`](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-3-7.html#--declaration-and---allowjs) in TypeScript to generate their types. @@ -82,7 +82,7 @@ The process of handling PRs: - [dt-merge-bot](https://github.com/RyanCavanaugh/dt-mergebot/) - the bot which sets the labels on PRs, and update's project status - [dt-merge-bot graphql](https://github.com/RyanCavanaugh/dt-mergebot/tree/use-graphql) - the WIP v2 of the bot to automate the labels/projects - [focus-dt](https://github.com/DefinitelyTyped/focus-dt) - a tool which controls chrome to load up the next PR to review, so you can focus -- [dtslint](https://github.com/microsoft/dtslint) - the CLI tool used to validate PRs on DefinitelyTyped +- [dtslint](https://github.com/microsoft/dtslint) - the CLI tool used to validate PRs on Definitely Typed The process of deploying changes: diff --git a/scripts/update-codeowners.js b/scripts/update-codeowners.js index 56eda138c6..1f6947e3a2 100644 --- a/scripts/update-codeowners.js +++ b/scripts/update-codeowners.js @@ -90,7 +90,7 @@ function padNum(number) { const header = `# This file is generated. # Add yourself to the "Definitions by:" list instead. -# See https://github.com/DefinitelyTyped/DefinitelyTyped#edit-an-existing-package`; +# See https://github.com/DefinitelyTyped/DefinitelyTyped#definition-owners`; /** * @param { { contributors: ReadonlyArray<{githubUsername?: string }>, subDirectoryPath: string} } pkg diff --git a/types/aws-lambda/README.md b/types/aws-lambda/README.md index 135d7a7a57..43fae797ad 100644 --- a/types/aws-lambda/README.md +++ b/types/aws-lambda/README.md @@ -81,7 +81,7 @@ to a new trigger, also add the change to the tests. Tests are grouped by each service in [test/](), and must also be explicitly added to `tsconfig.json`'s `files` list (use of `include` is banned by -DefinitelyTyped at the moment). +Definitely Typed at the moment). The test file for a service `foo` with two triggers `bar` and `baz` may look like: @@ -186,4 +186,4 @@ prepared to make a decently strong case for why this is an exception. 400 error, or parsing CloudWatch log payloads. This one is much more fraught, as it by default loses all the existing - DefinitelyTyped tooling and community support (e.g. cross package typing). + Definitely Typed tooling and community support (e.g. cross package typing). diff --git a/types/node-forge/README.md b/types/node-forge/README.md index 98180a3856..2c2cd585bf 100644 --- a/types/node-forge/README.md +++ b/types/node-forge/README.md @@ -1,4 +1,4 @@ -# DefinitelyTyped for node-forge +# Definitely Typed for node-forge ## Current node-forge Version `v0.9.1` diff --git a/types/sawtooth-sdk/README.md b/types/sawtooth-sdk/README.md index bcf4378cb5..3df82c81c0 100644 --- a/types/sawtooth-sdk/README.md +++ b/types/sawtooth-sdk/README.md @@ -14,13 +14,13 @@ https://github.com/hyperledger/sawtooth-sdk-javascript This project will need to be maintained as the SDK is updated. -The best way to verify new contributions is to test them out in an existing TypeScript project that uses the new features from the Sawtooth SDK that are missing from DefinitelyTyped. Then, verify that the new definitions are tested properly in DefinitelyTyped before opening a PR. +The best way to verify new contributions is to test them out in an existing TypeScript project that uses the new features from the Sawtooth SDK that are missing from Definitely Typed. Then, verify that the new definitions are tested properly in Definitely Typed before opening a PR. ### Setup Create a fork of [DefinitelyTyped](https://github.com/DefinitelyTyped/DefinitelyTyped) and clone it locally. `cd` into the project and run `npm install`. -Copy over the contents of `types/sawtooth-sdk` from your DefinitelyTyped fork to the `node_modules/@types` folder in your project, e.g. +Copy over the contents of `types/sawtooth-sdk` from your Definitely Typed fork to the `node_modules/@types` folder in your project, e.g. ```sh cd /path/to/DefinitelyTyped @@ -54,7 +54,7 @@ If a new protobuf is added to the SDK, follow these steps to re-generate the def ### Testing -When you are confident the new types are accurate, copy the changes back to DefinitelyTyped in `types/sawtooth-sdk`. +When you are confident the new types are accurate, copy the changes back to Definitely Typed in `types/sawtooth-sdk`. Before opening a PR you will need to write new tests for the updates you've made. @@ -72,7 +72,7 @@ const signerPubKey = signer.getPublicKey(); #### Running tests -To verify the correctness of any changes, run the following tests from the root of DefinitelyTyped. +To verify the correctness of any changes, run the following tests from the root of Definitely Typed. ```sh $ npm run prettier -- --write types/sawtooth-sdk/**/*.ts @@ -82,6 +82,6 @@ $ npm run test ### Opening A PR -At this point your changes should be ready to submit in a PR. Follow [these instructions on Editing An Existing Package](https://github.com/DefinitelyTyped/DefinitelyTyped#edit-an-existing-package) in DefinitelyTyped. +At this point your changes should be ready to submit in a PR. Follow [these instructions on Editing An Existing Package](https://github.com/DefinitelyTyped/DefinitelyTyped#edit-an-existing-package) in Definitely Typed. ### Copyright (c) 2020 Target Brands, Inc.