Skip to content
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.

Sign up for GitHub

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

Jump to bottom

[🔥] Revised README #8076

Merged
merged 1 commit into from
Mar 18, 2019
Merged

[🔥] Revised README #8076

merged 1 commit into from
Mar 18, 2019

Conversation

orta
Copy link
Member

@orta orta commented Mar 7, 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.

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 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.

@SimenB
Copy link
Member

SimenB commented Mar 7, 2019

Woo!

The readme is synced with GettingStarted.md, mind making sure they stay consistent?

@natealcedo
Copy link

Oh I love this! Thanks for the work you've done.

thymikee
thymikee approved these changes Mar 8, 2019
View reviewed changes
Copy link
Collaborator

@thymikee thymikee left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

like it

@SimenB
Copy link
Member

SimenB commented Mar 9, 2019

We should note babel 6 support, but it doesn't need to take up space

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 getting started instead

@orta orta force-pushed the new_readme branch 2 times, most recently from 5cda78e to 4228e54 Compare March 9, 2019 12:36
@orta
Copy link
Member Author

orta commented Mar 9, 2019

Agreed, and updated 👍

jeysal
jeysal approved these changes Mar 9, 2019
View reviewed changes
Copy link
Contributor

@jeysal jeysal left a 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 😄

@SimenB
Copy link
Member

SimenB commented Mar 9, 2019

Looks a bit weird with dark github btw. Maybe make the background in the top banner transparent instead of white? Might not help

image

@thymikee thymikee mentioned this pull request Mar 13, 2019
Closed
cpojer
cpojer approved these changes Mar 18, 2019
View reviewed changes
Copy link
Member

@cpojer cpojer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

NICE

@cpojer cpojer merged commit 4ba05b7 into jestjs:master Mar 18, 2019
thymikee added a commit to Brantron/jest that referenced this pull request Mar 19, 2019
@thymikee
Merge remote-tracking branch 'upstream/master' into pr/7167
9d39e68 
* 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)
  ...
@github-actions
Copy link

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.
Please note this issue tracker is not a help forum. We recommend using StackOverflow or our discord channel for questions.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators May 11, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@jeysal jeysal jeysal approved these changes

@thymikee thymikee thymikee approved these changes

@cpojer cpojer cpojer approved these changes

Assignees
No one assigned
Labels
cla signed
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
7 participants
@orta @SimenB @natealcedo @cpojer @thymikee @jeysal @facebook-github-bot