Minor update to plugin-transform-typescript.md #1982
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Deploy preview for babel ready! Built with commit 845d4ff |
|
@orta thanks! |
cpojer
pushed a commit
to jestjs/jest
that referenced
this pull request
Mar 18, 2019
👋 been having a think about READMEs lately, and wanted to try give the README a fresh perspective and kinda bring it inline with the jestsj.io update. - Current: [README](https://github.com/facebook/jest/blob/690221b5db85e024e2738d30ed2633275d4c63ab/README.md) - New: [README](https://github.com/orta/jest/blob/new_readme/README.md) Major focuses: - Removal of most badges. This isn't a hill I'll die on, but TBH, most of them provide little value to someone looking at using Jest. - Knowing the CI is green for a small project is _reasonably_ useful, barely. Knowing CI is green three times on a large project isn't. We're very unlikely to leave jest as red CI for very long, given the domain Jest is in. - Knowing the current version of Jest on NPM is pretty useful, especially as the major is so high, so I kept that - I think the open collective numbers are _kinda_ useful, (as a user, knowing that there's potential long-term stability) but there's a lot of space given to them at the bottom of the readme - I did think the 'breaks semver' one was clever, so am open to that coming back somehow, but still not sure that's something someone would really care about - Moved some more advanced-y, or edge-cases-y docs into `<details>` - We should note babel 6 support, but it doesn't need to take up space - We've never checked for Jest inside babel at Artsy, so I think it's probably an edge case, so I moved that into a summary also - Gave the TypeScript docs a one-over. I improved the copy in the docs, and inlined the examples of how to get started, given that it's not much extra. I switched the reference link from our Artsy post, to the official babel docs (and improved them again babel/website#1982 ) - mainly because our post reflected the alpha+beta stuff, and some of that isn't valid anymore, better to have it focus on the canonical docs here. Also managed to get some of the descriptions down to a single line of text in the README, which is always a win in my book. This also de-Reacts it a little bit too.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Moves the workarounds to their own line (but still inside the
<li>) - it makes the section read better.