[Docs]: Add README.md to `jest-util`

[SimenB]

Page(s)

https://github.com/jestjs/jest/tree/v29.6.4/packages/jest-util has no README.md

Description

jest-util is currently downloaded almost 60M times weekly, but it has no README file. We should rectify this! It's just a collection of helpers and utils and should be straight forward to document.

https://github.com/jestjs/jest/tree/v29.6.4/packages/jest-util/src/index.ts

[malaviya-parth]

I would like to add this readme file

[SimenB]

Sweet, thanks!

[Delapouite]

SimenB, what's your opinion about all other directories in jest/packages/?

Should these packages also deserve there own README files as well? At least a minimal one to avoid staring at a blank page when consulted through npmjs.com?

In such case, we could open new related GitHub issues and complete the platform page in the documentation with pointers to the new READMEs : https://jestjs.io/docs/jest-platform

[SimenB]

SimenB, what's your opinion about all other directories in jest/packages/?

Should these packages also deserve there own README files as well? At least a minimal one to avoid staring at a blank page when consulted through npmjs.com?

In such case, we could open new related GitHub issues and complete the platform page in the documentation with pointers to the new READMEs : jestjs.io/docs/jest-platform

Yeah, that'd be ideal 👍

[github-actions]

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