-
-
Notifications
You must be signed in to change notification settings - Fork 6.5k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[🔥] Revised README #8076
[🔥] Revised README #8076
Conversation
Woo! The readme is synced with GettingStarted.md, mind making sure they stay consistent? |
Oh I love this! Thanks for the work you've done. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
like it
Does not need to be mentioned in the main readme at all, IMO. Just saying "babel support" with no code seems better, and link to |
5cda78e
to
4228e54
Compare
Agreed, and updated 👍 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sleek! Although I'm sad to see the blazing badge go 😄
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
NICE
* upstream/master: (391 commits) more precise circus asyncError types (jestjs#8150) Add typeahead watch plugin (jestjs#6449) fix: getTimerCount not taking immediates and ticks into account (jestjs#8139) website: add an additional filter predicate to backers (jestjs#7286) [🔥] Revised README (jestjs#8076) [jest-each] Fix test function type (jestjs#8145) chore: improve bug template labels for easier maintenance (jestjs#8141) Add documentation related to auto-mocking (jestjs#8099) Add support for bigint to pretty-format (jestjs#8138) Revert "Add fuzzing based tests in Jest (jestjs#8012)" chore: remove console.log chore: Improve description of optional arguments in ExpectAPI.md (jestjs#8126) Add fuzzing based tests in Jest (jestjs#8012) Move @types/node to the root package.json (jestjs#8129) chore: use property initializer syntax (jestjs#8117) chore: delete flow types from the repo (jestjs#8061) Move changelog entry to the proper version (jestjs#8115) Release 24.5.0 Expose throwOnModuleCollision (jestjs#8113) add matchers to expect type (jestjs#8093) ...
This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs. |
👋 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.
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.
Moved some more advanced-y, or edge-cases-y docs into
<details>
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 Minor update to plugin-transform-typescript.md 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.