WordPress / WordPress/wordpress-playground

Include instructions on post-publish smoke tests

Open
#412 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

[Type] Developer Experience [Type] Documentation [Type] Enhancement
Dominant language
JavaScript
Stars
2k
Forks
462
Avg merge
18h 44m
Merged PRs (30d)
33

Description

It would be helpful to have some smoke test instructions here: https://wordpress.github.io/wordpress-playground/docs/contributing/publishing#npm-packages

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.

Research direction

Open the linked publishing documentation page and review the section for npm packages. Add instructions describing post-publish smoke tests, with enough detail for contributors to verify a publication is working; the documentation page should clearly include those checks when done.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.