Skip to content

add deprecate guidelines doc [draft] - #150

Merged
mhdawson merged 22 commits into
nodejs:masterfrom
jchip:master
Jun 5, 2019
Merged

mhdawson merged 22 commits into
nodejs:masterfrom
jchip:master

Conversation

@jchip

@jchip jchip commented Feb 5, 2019

Copy link
Copy Markdown
Contributor

No description provided.

Comment thread docs/drafts/DEPRECATE-GUIDELINES.md Resolved
Comment thread docs/drafts/DEPRECATE-GUIDELINES.md Resolved
Comment thread docs/drafts/DEPRECATE-GUIDELINES.md Resolved
Comment thread docs/drafts/DEPRECATE-GUIDELINES.md Resolved
Comment thread docs/drafts/DEPRECATE-GUIDELINES.md Resolved
Comment thread docs/drafts/DEPRECATE-GUIDELINES.md Resolved
Comment thread docs/drafts/DEPRECATE-GUIDELINES.md Resolved
Comment thread docs/drafts/DEPRECATE-GUIDELINES.md Resolved
@mcollina mcollina added the package-maintenance-agenda Agenda items for package-maintenance team label Feb 11, 2019
Comment thread docs/drafts/DEPRECATE-GUIDELINES.md Resolved
Comment thread docs/drafts/DEPRECATE-GUIDELINES.md Resolved
@mhdawson

Copy link
Copy Markdown
Member

I think this might be mixing different concerns. What should a consumer do and what might this team do. Would it make sense to break it out into those 2 sections or possibly 2 doc?

@jchip
jchip requested review from Eomm, ljharb and mhdawson March 7, 2019 16:57
@jchip

jchip commented Mar 7, 2019

Copy link
Copy Markdown
Contributor Author

I made some changes with target audience in mind. Please re-review.

Comment thread docs/drafts/DEPRECATE-GUIDELINES.md Resolved
Comment thread docs/drafts/DEPRECATE-GUIDELINES.md Resolved
Comment thread docs/drafts/DEPRECATE-GUIDELINES.md Outdated
### Taking Further Actions

## `npm deprecate` command
Once you've identified a package may be unmaintained, please open an issue for the Node.js package-maintenance working group to check and identify path forward.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this the right recommendation? I would like to see package-maintenance group to be the last resort (depending on popularity of the package, of course), but I would generally recommend looking for alternatives (are there any tools out there?) and then forking, i.e. dyi?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Forking is an important ability, but I see that as more of a last resort than asking this group - creating forks further fractures the ecosystem, and doesn't help all of the users who are still using the unmaintained version unwittingly.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

if no one can reach the author then there's really not much anyone could do. I was thinking that the best this group could do is get npm ownership and actively advertise for someone interested in becoming the maintainer, and/or add deprecate message to identify alternative if one exist.

Comment thread docs/drafts/DEPRECATE-GUIDELINES.md Resolved
Comment thread docs/drafts/DEPRECATE-GUIDELINES.md Resolved
Comment thread docs/drafts/DEPRECATE-GUIDELINES.md Resolved
Comment thread docs/drafts/DEPRECATE-GUIDELINES.md Resolved
Comment thread docs/drafts/DEPRECATE-GUIDELINES.md Resolved
Comment thread docs/drafts/DEPRECATE-GUIDELINES.md Resolved
Comment thread docs/drafts/DEPRECATE-GUIDELINES.md Outdated
### Taking Further Actions

## `npm deprecate` command
Once you've identified a package may be unmaintained, please open an issue for the Node.js package-maintenance working group to check and identify path forward.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Forking is an important ability, but I see that as more of a last resort than asking this group - creating forks further fractures the ecosystem, and doesn't help all of the users who are still using the unmaintained version unwittingly.

Comment thread docs/drafts/DEPRECATE-GUIDELINES.md Resolved
Comment thread docs/drafts/DEPRECATE-GUIDELINES.md Resolved
Comment thread docs/drafts/DEPRECATE-GUIDELINES.md Resolved
ljharb and others added 8 commits March 11, 2019 10:49
Co-Authored-By: jchip <jchip@users.noreply.github.com>
Co-Authored-By: jchip <jchip@users.noreply.github.com>
Co-Authored-By: jchip <jchip@users.noreply.github.com>
Co-Authored-By: jchip <jchip@users.noreply.github.com>
Co-Authored-By: jchip <jchip@users.noreply.github.com>
Co-Authored-By: jchip <jchip@users.noreply.github.com>
Co-Authored-By: jchip <jchip@users.noreply.github.com>
Comment thread docs/drafts/DEPRECATE-GUIDELINES.md Resolved
Comment thread docs/drafts/DEPRECATE-GUIDELINES.md Resolved
ljharb and others added 2 commits April 16, 2019 08:46
@mcollina

Copy link
Copy Markdown
Member

@jchip are you still interested in getting this PR landed? Otherwise, is there anybody else that would like to help in moving this forward?

@craftninja

Copy link
Copy Markdown
Contributor

@jchip I'd be glad to take this over if you don't have time, no pressure!

@jchip

jchip commented May 21, 2019

Copy link
Copy Markdown
Contributor Author

@mcollina I addressed the review comments in my last commit and I don't see any further comments. I was hoping for enough approves to move this to be considered for merging.

@craftninja Thanks for the offer. I'd like to see if there're anymore comments and see if this PR can get enough approves to be considered merging. I generally have problem attending every other meeting due to me being in PST, but will see if I can get this discussed and merge in next meeting.

@jchip
jchip requested review from dominykas and ljharb May 23, 2019 16:33

@ljharb ljharb left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I still have a large number of open suggestions; I’ve commented on a few.

Comment thread docs/drafts/DEPRECATE-GUIDELINES.md Resolved
Comment thread docs/drafts/DEPRECATE-GUIDELINES.md Resolved
Comment thread docs/drafts/DEPRECATE-GUIDELINES.md Resolved
jchip and others added 7 commits May 24, 2019 12:45
Co-Authored-By: Jordan Harband <ljharb@gmail.com>
Co-Authored-By: Jordan Harband <ljharb@gmail.com>
Co-Authored-By: Jordan Harband <ljharb@gmail.com>
Co-Authored-By: Jordan Harband <ljharb@gmail.com>
Co-Authored-By: Jordan Harband <ljharb@gmail.com>
Co-Authored-By: Jordan Harband <ljharb@gmail.com>
@jchip

jchip commented May 24, 2019

Copy link
Copy Markdown
Contributor Author

@ljharb thanks, going through them again.

On a side note, I miss them partly due to github has this curious way of reseting the page to the top after you commit each suggested changes, and then you have to scroll down, expand comments, and find back to where you were. Is that just me? Is there a better way?

Co-Authored-By: Jordan Harband <ljharb@gmail.com>
@jchip

jchip commented May 24, 2019

Copy link
Copy Markdown
Contributor Author

@ljharb that should be all of them. Please review. Thanks.

@Eomm

Eomm commented Jun 3, 2019

Copy link
Copy Markdown
Member

Only for note.

In a following PR, I think it could be worth adding some node args like --throw-deprecation

@dominykas dominykas left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice

@mhdawson mhdawson left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@mhdawson

mhdawson commented Jun 5, 2019

Copy link
Copy Markdown
Member

Looks like this is ready to land.

@mhdawson
mhdawson merged commit 293b0ab into nodejs:master Jun 5, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

package-maintenance-agenda Agenda items for package-maintenance team

Projects

None yet

Development

Successfully merging this pull request may close these issues.

8 participants