Skip to content

docs: align package READMEs (npm link, setup, publish flow) - #6

Merged
shaunburdick merged 1 commit into
mainfrom
docs/package-readme-updates
Aug 24, 2026
Merged

docs: align package READMEs (npm link, setup, publish flow)#6
shaunburdick merged 1 commit into
mainfrom
docs/package-readme-updates

Conversation

@shaunburdick

Copy link
Copy Markdown
Owner

Summary

Brings the two package READMEs in line with each other:

  • biome/README.md
    • Add npm package link: biome-config-shaunburdick (mirrors the eslint README)
    • Add Package Setup section with recommended package.json script entries (biome check . / --write) and the lint-in-test tip
    • Expand the one-line Versioning blurb into the full Major/Minor/Patch Versioning Policy matching the eslint and root READMEs
    • Add Publish steps documenting the automated CI flow (version bump on main → provenance publish → biome-vX.Y.Z GitHub release)
  • eslint/README.md
    • Fix stale Pull masterPull main
    • Document the same automated CI publish steps (release tag vX.Y.Z), verified against .github/workflows/eslint.yml

Verification

  • npm test in biome/: config lint clean, all 4 smoke tests pass
  • Docs-only change; no rule or config modifications

- biome/README.md: add npm package link, Package Setup section with
  recommended script entries, full Versioning Policy breakdown, and
  Publish steps reflecting the automated CI publish flow
- eslint/README.md: fix stale 'Pull master' reference and document the
  automated CI publish steps to match the biome README
@shaunburdick
shaunburdick merged commit 9e0e65c into main Aug 24, 2026
14 checks passed
@shaunburdick
shaunburdick deleted the docs/package-readme-updates branch August 24, 2026 19:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant