Skip to content

Update README about published guide and maintainers #19

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

Merged
joyeecheung merged 2 commits into from
Jan 8, 2026
Merged

Update README about published guide and maintainers #19

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ef473ee
Update README about published guide and maintainers
joyeecheung Jan 8, 2026
b2be079
fixup! Update README about published guide and maintainers
joyeecheung Jan 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 9 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,15 @@
# Node.js package shipping patterns

> [!NOTE]
> This repository is currently under construction. It's meant to replace the sections in the Node.js package documentation for documenting package shipping patterns, the pros and cons, and guidelines for CJS to ESM migration.
This project is meant to document common package shipping patterns, the pros and cons, and guidelines for CJS to ESM migration.

A team is being formed to get this effort up and going! See [Issue #3](https://github.com/nodejs/package-examples/issues/3) for details.
The guide on package configuration is published at <https://nodejs.github.io/package-examples/>. Source document and examples are in the [guide/](./guide/) directory.

⚒️ The package shipping guide is being worked on [here](./guide/) . See [contribution guide](./CONTRIBUTING.md) on how to contribute to it.
For a quick overview of what the guide covers, see [guide/SUMMARY.md](./guide/SUMMARY.md).
This guide is still in early stages. Contributions are welcome! See [contribution guide](./CONTRIBUTING.md) on how to contribute to this project.

The following teams have maintainer access to this repository:

- [Node.js Package Maintenance Team](https://github.com/orgs/nodejs/teams/package-maintenance)
- [Node.js Package Pathfinders Team](https://github.com/orgs/nodejs/teams/package-pathfinders)
- [Node.js Loaders Team](https://github.com/orgs/nodejs/teams/loaders)

The previous documents from package.md in the Node.js API documentation have been moved to [this chapter](./guide/07-dual-packages/README.md) for reference.