Skip to content

Conversation

@refack
Copy link
Contributor

Ratifying the decision from #13937

Checklist
Affected core subsystem(s)

doc,error

@nodejs-github-botnodejs-github-bot added the doc Issues and PRs related to the documentations. label Jul 19, 2017
@refackrefack requested a review from jasnellJuly 19, 2017 19:37
@refackrefack added errors Issues and PRs related to JavaScript errors originated in Node.js core. meta Issues and PRs related to the general management of the project. labels Jul 19, 2017
Copy link
Member

Choose a reason for hiding this comment

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

typos: than, and commas after future and )

also, I’d prefer Node 10.x over v10

Copy link
Member

Choose a reason for hiding this comment

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

I don't believe we can say "no sooner" than v10. The decision was to handle the changes as semver-major in 8.x and to revisit within 9.x... which means we could start handling them as semver-minor as early as 9.0.0.

Copy link
ContributorAuthor

Choose a reason for hiding this comment

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

Ack X 2

Copy link
Member

Choose a reason for hiding this comment

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

Nit: remove near

Copy link
ContributorAuthor

Choose a reason for hiding this comment

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

ack

Copy link
Member

Choose a reason for hiding this comment

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

Nit: will -> may

Copy link
ContributorAuthor

Choose a reason for hiding this comment

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

  • will hopefully? (if we're optimistic)
  • might? (if we're skeptic)
  • or even error message changes will be reevaluated, with the goal being to handle then as (if we want to explain)

Copy link
Member

@TrottTrott left a comment

Choose a reason for hiding this comment

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

Left some nits, but with or without 'em, LGTM.

Copy link
Member

@TimothyGuTimothyGu left a comment

Choose a reason for hiding this comment

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

LGTM with @Trott's nits addressed.

Copy link
ContributorAuthor

Choose a reason for hiding this comment

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

Still bikeshedding over will: #14375 (review)
image

Copy link
Contributor

Choose a reason for hiding this comment

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

what about should? That gives us the opportunity to change if we absolutely have to, but shows that is the direction we are trying to go?

Copy link
Member

Choose a reason for hiding this comment

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

I am pro should or your third suggestion @refack.

@refack
Copy link
ContributorAuthor

Went with should:

In the future, after the transition has been completed, error message changes should be handled as `semver-minor` or `semver-patch`.

Copy link
Member

Choose a reason for hiding this comment

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

Nit: This makes it sound like once the errors have been all migrated, the change to treating them as not-breaking is automatic. Honestly, I think the best/easiest thing to do at this point is to remove the sentence. It's not needed. It's about a possible future state that is likely to come (but not guaranteed) and we certainly haven't agreed as to exactly when it will come. So just leave it out.

Copy link
ContributorAuthor

Choose a reason for hiding this comment

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

Makes sense.
Originally I thought we should end with a "hopeful" note. But that's sort of the subject of the guide as a whole.

@refack
Copy link
ContributorAuthor

To all who approved, current status is that the sentence dealing with future plans was dropped. PTAL.

@Trott
Copy link
Member

Still LGTM.

Copy link
Member

@mcollinamcollina left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Contributor

Choose a reason for hiding this comment

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

I don't think this is 100% true, if the error message remains the same?

Copy link
ContributorAuthor

@refackrefackJul 21, 2017

Choose a reason for hiding this comment

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

The Error's name changes to ${super.name} [${this[kCode]}] so the .toString() changes.

PR-URL: nodejs#14375 Refs: nodejs#13937 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Timothy Gu <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Tobias Nießen <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Matteo Collina <[email protected]>
@refackrefackforce-pushed the semver-major-error-still branch from fa0fccb to ac81267CompareJuly 21, 2017 19:37
@refackrefack merged commit ac81267 into nodejs:masterJul 21, 2017
addaleax pushed a commit that referenced this pull request Jul 22, 2017
PR-URL: #14375 Refs: #13937 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Timothy Gu <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Tobias Nießen <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Matteo Collina <[email protected]>
Fishrock123 pushed a commit that referenced this pull request Jul 24, 2017
PR-URL: #14375 Refs: #13937 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Timothy Gu <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Tobias Nießen <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Matteo Collina <[email protected]>
@addaleaxaddaleax mentioned this pull request Jul 24, 2017
@addaleaxaddaleax mentioned this pull request Aug 2, 2017
@refackrefack deleted the semver-major-error-still branch September 4, 2017 21:55
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docIssues and PRs related to the documentations.errorsIssues and PRs related to JavaScript errors originated in Node.js core.metaIssues and PRs related to the general management of the project.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

13 participants

@refack@Trott@mcollina@jasnell@evanlucas@addaleax@Fishrock123@lpinca@TimothyGu@cjihrig@tniessen@MylesBorins@nodejs-github-bot