WordPress / WordPress/wordpress-playground

Some NPM packages do not have a README

Open
#1,925 8 comments 1 reaction 1 assignee View on GitHub

A pull request for this has already been merged.

  • #2156 by @bgrgicak — merged
[Focus] Developer Tools [Type] Bug [Type] Developer Experience
Dominant language
JavaScript
Stars
2k
Forks
462
Avg merge
18h 44m
Merged PRs (30d)
33

Description

The following packages do not have a README.md at npmjs.com, even though they do contain a README.md in their source:

The README is missing from the packages because the vite build removes it, I believe.

Using @wp-playground/client as an example, when running npx nx build playground-client, one can see the README.md initially being placed under dist/, and then being removed once the vite build completes.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.