Commit Graph

482 Commits

Author SHA1 Message Date
Orta
72c1e33e13
Improve docs on 'testing' a dt module (#43748)
* Improve docs on 'testing' a dt module

* Duplicate saying how you can test your tests

* Apply suggestions from code review

Co-Authored-By: Nathan Shively-Sanders <293473+sandersn@users.noreply.github.com>

* Update docs with recommendations

* Apply suggestions from code review

Co-Authored-By: Nathan Shively-Sanders <293473+sandersn@users.noreply.github.com>

* Changes from reviews and link from the PR template

Co-authored-by: Nathan Shively-Sanders <293473+sandersn@users.noreply.github.com>
2020-04-11 13:40:47 -04:00
Kagami Sascha Rosylight
bc6280c39e
Update README.ko.md (#42958) 2020-03-06 13:58:01 -08:00
Nikita Galkin
958ad18f21
Update Readme for Russian language (#42881) 2020-03-06 09:18:27 -08:00
Nathan Shively-Sanders
09dc238010
Add deprecation schedule (#42834)
* Add deprecation schedule

and explain tags a bit more fully

* improved formatting
2020-03-04 15:39:36 -08:00
Rohit Gohri
865ae1f9a8
Add prettier npm script and update command in docs (#42365) 2020-02-14 14:42:48 -05:00
Piotr Błażejewicz (Peter Blazejewicz)
699dd6b2e2 docs(readme): Add hint about prettier ignore (#41593)
This is an aftermath of problem discussed here:
https://github.com/DefinitelyTyped/DefinitelyTyped/pull/41567#discussion_r365882974

Thanks!
2020-01-17 11:43:24 -05:00
Orta
9f2b299e70
Adds some admin docs (#41063)
* Adds some admin docs

* Update admin manual

* Update docs/admin.md

Co-Authored-By: Nathan Shively-Sanders <293473+sandersn@users.noreply.github.com>

* More docs on admin

Co-authored-by: Nathan Shively-Sanders <293473+sandersn@users.noreply.github.com>
2019-12-24 16:34:27 +00:00
Nathan Shively-Sanders
dd4016e519
Update status badges (#40978)
Point to dev.azure.com/DefinitelyTyped instead of /Microsoft.
2019-12-11 13:30:12 -08:00
Nathan Shively-Sanders
7926ae9ff5
Update new package instructions (#40677)
1. Only index.d.ts is allowed in files list; all other d.ts files should be
referenced from it.
2. Unreferenced files that nonetheless need to ship can be added to
OTHER_FILES.txt
2019-11-26 12:48:58 -08:00
Nathan Shively-Sanders
9314b64275
Streamline references to old Typescript versions. (#40418)
Also mention triple-slash `types` references.
2019-11-15 08:46:48 -08:00
Nathan Shively-Sanders
a4560c4eb2
Update readme for 2.0-2.7 deprecation (#40222)
* Update readme for 2.0-2.7 deprecation

* Add example of dist-tags with react

* shorten dist-tag table
2019-11-07 13:48:58 -08:00
Nathan Shively-Sanders
b899dec969 Improve README on external dependencies (#38784) 2019-10-01 15:51:57 -07:00
Andrii Dieiev
a4a55f6c85 Fix link to Linter section in ToC (#38523) 2019-09-24 10:46:08 -07:00
Orta
09209d6c8c
Update README.md (#38247)
* Update README.md

* Update README.md
2019-09-09 19:01:32 +02:00
Nathan Shively-Sanders
6b9b1b15de Update README to require spaces (#36595) 2019-07-02 09:27:47 -07:00
bookmoons
da2e588a1c Add missing word (#36337)
Adds missing word to English readme
in the "Test a new package" section.
2019-06-27 16:10:49 -07:00
cs464osu
7b78891f8c Readme TOC (#36039) 2019-06-13 22:01:24 -07:00
Nathan Shively-Sanders
7ee6546bde
Switch status badges to Azure Pipelines (#36004)
* Add typescript@next build status badge

* Switch main build badge to Azure as well

Also be more honest about wording -- a green badge doesn't mean a clean
build, just that the most recent changes were clean.
2019-06-06 14:07:14 -07:00
Kerminate
9286ec2fcd Add Chinese README. (#35941)
* feat: create README.cn.md

* chore: add Chinese README
2019-06-04 13:35:09 -07:00
Shawn Choi
2a9c2121c9
Fix legacy ref for breaking version bump in ReadMe.md 2019-04-13 22:28:28 -07:00
Daniel Rosenwasser
5d15e3d158
Merge pull request #34188 from nwtgck/remove-package-description
Add a description about asOfVersion in "Removing a package"
2019-04-03 11:34:23 -07:00
briwa
dd162faacc Remove GA beacon since it won't work (#34110) 2019-03-27 09:33:50 -07:00
Ryo Ota
242fc8cb64 Add a description about asOfVersion in "Removing a package" 2019-03-26 00:02:23 +09:00
Nathan Shively-Sanders
c83a11c439 Detail on deprecated packages with dependents 2019-03-14 14:47:02 -07:00
Nathan Shively-Sanders
b1ea8b036e Update README
1. Update meaning of libraryName for deprecated packages.
2. Update spelling of Definitely Typed.
2019-03-14 14:02:16 -07:00
Daniel Rosenwasser
0b417416fe
Merge pull request #30746 from justingrant/patch-1
[meta] Update README docs to clarify versioning behavior
2019-02-06 18:42:27 -08:00
Daniel Rosenwasser
0f1a0a5d6e
Update README.md 2019-02-06 18:38:21 -08:00
Nathan Shively-Sanders
8803b9e34b Update README with links to gitter and infrastructure
Also reduce the expected time before NPM publishing to "a few minutes"
and the allowed time to "an hour" instead of "an hour" and "24 hours".
2019-02-05 15:19:44 -08:00
Nathan Shively-Sanders
b107cbd243
Merge pull request #32592 from DefinitelyTyped/readme/remove-typesVersions-requirement
Update README to make typesVersions optional
2019-01-30 16:28:48 -08:00
Nathan Shively-Sanders
eb0e2a8404 Update README to make typesVersions optional 2019-01-29 08:31:18 -08:00
Dimitri Benin
ac3723c88c [README] improve FAQ section on module interop schemes 2019-01-25 10:54:26 +01:00
Dimitri Benin
c0ff4d5e84 [README] add section on how to author types for ts >= 3.1 2019-01-23 01:56:56 +01:00
Daniel Rosenwasser
d0ee8b553c
Update README.md 2019-01-14 14:57:22 -08:00
Daniel Rosenwasser
49532fa9f9
Update README.md 2019-01-14 14:04:26 -08:00
Daniel Rosenwasser
39dba63ebe
Bring build/health status to the top of the README 2019-01-14 14:03:13 -08:00
Daniel Rosenwasser
72d8ba2ffc
Update README.md 2019-01-02 09:03:35 -08:00
Victor Irzak
bbe324b28b Added Russian readme 2018-12-27 10:51:55 -05:00
Jesse Trinity
291ba3002e
Clarifying tslint.json content instructions
The language and examples surrounding linting of new packages is ambiguous. This makes the language and examples more explicit in an attempt to direct contributors to remove linting rules from tslint.json before opening PRs.
2018-12-11 11:08:16 -08:00
Justin Grant
60a7ec20ee
Updated in response to @DanielRosenwasser feedback
Thanks @DanielRosenwasser for feedback! Here's what's different: 
* Updated typos: contaiin,  udpated, udpate, mainatiners
* One sentence per line, except bullet points where adding a newline will show up in user-visible text (GitHub markdown doesn't ignore line breaks in bullet points)
* Removed "typings", replaced with either "type definition(s)" or "type definition package" depending on context

Happy to make more edits, just let me know.
2018-12-04 12:26:57 -08:00
Nathan Shively-Sanders
75cbccb548 Nope, the images were backward too 2018-11-28 14:02:28 -08:00
Nathan Shively-Sanders
a6cc14597d Swap types-publisher/typescript-bot status badge links
The links were backward, but not the images.
2018-11-28 11:09:56 -08:00
Nathan Shively-Sanders
2b17e0bbf1 Move badges to bottom 2018-11-28 10:13:52 -08:00
Nathan Shively-Sanders
be8aa46189 Add status badges 2018-11-28 10:11:58 -08:00
Justin Grant
30c8898e68
Changes in response to @Flarna review 2018-11-23 18:17:19 -08:00
Justin Grant
8a7c70eb95
Updated to clarify versioning behavior
Fixed a few things with version-related documentation: 

* clarified the relationship of typings package version vs. library versions
* explained how package versions and library versions can get out of sync
* fixed broken links in major-version-upgrade section
* clarified major-version-upgrade section

See #25677 for more discussion and background for these changes.
2018-11-21 19:14:37 -08:00
Junyoung Clare Jang
44f4f58991 Fix broken README link to korean README (#27903) 2018-08-06 09:39:22 -07:00
Junyoung Clare Jang
e53465fb03 Add korean readme (#27742) 2018-08-06 09:28:20 -07:00
Simon Legner
f5421fafbc
README: link to module-augmentation anchor 2018-06-12 10:07:46 +02:00
Ron Buckton
680d7edac3
Merge pull request #25633 from Aankhen/mention-npx-in-readme
Mention npx when talking about dts-gen in README.md
2018-05-18 12:03:03 -07:00
ryym
5e47df0e65 Add a link about major version update in 'Make a pull request' section (#25663) 2018-05-10 13:16:28 -07:00