Skip to content

Commit

Permalink
doc: promote from Draft
Browse files Browse the repository at this point in the history
Signed-off-by: Michael Dawson <[email protected]>
  • Loading branch information
mhdawson committed Oct 12, 2021
1 parent cdb00ef commit 0e8099b
Showing 1 changed file with 1 addition and 9 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -70,17 +70,15 @@ Once you've identified a package may be unmaintained, there are some basic actio
- If you don't want to publish a modified copy under a different name, then consider using a tool like <https://github.com/ds300/patch-package>.
- Consider becoming a maintainer for the package. How to do that is currently under discussions.
- This working group has an active issue here https://github.com/nodejs/package-maintenance/issues/155
- The ultimate ownership rests upon npm and currently the dispute doc outlines the best course of action https://docs.npmjs.com/misc/disputes.html
- The ultimate ownership rests upon npm and currently the dispute doc outlines the best course of action https://docs.npmjs.com/policies/disputes.
- Search for a maintained alternative that may meet your requirements better.
- Please open an issue for the Node.js package-maintenance working group so that we may request for npm ownership in case someone's interested in maintaining the package.

### For Package Owners

If you own a package and you want to stop maintaining it, then please help your users by making it known. Some simple actions you can take:

- Use the `npm deprecate` command to mark package as unmaintained.
- Add a note to your repo's `README.md` file.
- Reach out to the Node.js package-maintenance working group to offer us ownership so we can hand it off to a new owner.
- Update the `support` levels in your `package.json` according to the [support level doc]

#### `npm deprecate` command
Expand Down Expand Up @@ -112,10 +110,4 @@ There are some ongoing discussion related to npm to make managing unmaintained p

- Package override RFC https://github.com/aeschright/rfcs/blob/ca127d7c5fb7ecde534172d771351c0b8f819e79/accepted/0009-package-overrides.md

Other ideas for tools that could help:

- request new support of `npm deprecate` to allow deprecating versions published before a given time
- use npm 6.9+'s aliasing ability to provide a replacement for transitive deps. You can find more info about this at https://github.com/npm/rfcs/blob/latest/implemented/0001-package-aliases.md
- if author simply can't be reached and package is very outdated, then need to contact npm to get access to deprecate package.

[support level doc]: https://github.com/nodejs/package-maintenance/blob/master/docs/drafts/Baseline%20practice%20-%20Document%20support%20levels.md

0 comments on commit 0e8099b

Please sign in to comment.