Skip to content
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.

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

add deprecate guidelines doc [draft] #150

Merged
merged 22 commits into from
Jun 5, 2019
Merged
Changes from 1 commit
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
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
Prev Previous commit
Next Next commit
update for review comments
  • Loading branch information
jchip committed Feb 11, 2019
commit aa8e0dab0e325d83ce1121b2bc8d8cb93cef2610
14 changes: 7 additions & 7 deletions docs/drafts/DEPRECATE-GUIDELINES.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,12 @@ These guidelines exist to help with the course of actions to take in the event t

## What consititutes an unmaintained package?

- The author is no longer responding to questions, issues, PRs, or making any updates.
- The author is no longer responding to questions, issues, PRs, or making any updates, and specifically repeat "are you there" inquries for critical issues.
jchip marked this conversation as resolved.
Show resolved Hide resolved
- The author may have explicitly indicated that they will stop all activities on the package.
- A different package that's more active and the author acknowledged as the replacement.
jchip marked this conversation as resolved.
Show resolved Hide resolved
- Critical issues exist for the package and not being addressed
jchip marked this conversation as resolved.
Show resolved Hide resolved
- Known vulnerabilities identified by `npm audit` or other parties
- Package is known to fail for LTS NodeJS
- Package is known to fail for LTS Node.js

## Identifying unmaintained package?

Expand All @@ -28,7 +28,7 @@ These guidelines exist to help with the course of actions to take in the event t
- file high priority issues in the package's repo

- if npm audit identified vulnerabilities that are critical
- if package is broken or fail to install for a LTS release of NodeJS
- if package fails to install/build for an LTS release of node.js

- if author indicate they are no longer interested in maintaining, then add as unmaintained candidate
- if no response within three months, then add as unmaintained candidate.
Expand All @@ -51,18 +51,18 @@ These guidelines exist to help with the course of actions to take in the event t
- if author simply can't be reached and package is very outdated, then need to contact npm to get access to deprecate package.

* A cli to allow `npm deprecate` a range of versions on a package.
jchip marked this conversation as resolved.
Show resolved Hide resolved
* or `npm deprecate` versions with published date older than a given time
* or request new support of `npm deprecate` to allow deprecating versions published before a given time

## Identify replacement

- If a package is fully unmaintained, then a replacement should be identify and add to the deprecate message.
- If no replacement exist, then should identify the safe versions to use in deprecate message.
- If a package is fully unmaintained, then a replacement should be identified and added to the deprecation message.
- If no replacement exists, then should identify the safe versions to use in the deprecation message.

## Encourage Author to deprecate versions

- File issue in repo to encourage author to deprecate a version that:
- Has known critical bugs and should be avoided
- Known to fail for LTS NodeJS
- Known to fail for LTS Node.js
- Has known critical vulnerabilities

Eomm marked this conversation as resolved.
Show resolved Hide resolved
## What user can do to avoid deprecate versions
Expand Down