-
Notifications
You must be signed in to change notification settings - Fork 29.9k
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
[REQUEST]: Document Breaking Changes in 9.0 #16713
Comments
Fwiw, there is a list of breaking changes in the changelog for Node 9. |
Suggestion: "semver-major" is jargon that should be replaced with "breaking changes" in the changelog. This would seem to be a common practice and something that is widely understood. Searching for |
Yeah I definitely did not know that is what that meant at all. I knew semver-major meant that, but I didn't put it together that I would look for breaking changes there when I was scanning the docs. |
We can have a glossary like the one chromium has. EDIT: still not everyone will look it up so yeah should probably name them breaking changes in the changelog or add a note |
It just has to be under releases here. You can keep semver-major or w/e but just headline it at the top / separate them so it ends up like: Semver-Major (Breaking Changes)
|
One thing that I've done for all of the major releases is separate out the |
You could definitely just break it into two semver-major headlines. Semver-Major (Breaking)
Semver-Major
|
The issue primarily is that what is breaking for some might not be breaking for others, and unfortunately we don't know which is which. Perhaps |
Yeah I think as long as it were annotated in any capacity somewhere it will be more than enough. I honestly ignore most of those and read just the top headlines usually (and im sure that is the common case for people) - unless there is something specific I care about (like the HTTP/2 ones in the latest releases). However, if I saw Breaking anywhere as I scan through it I would definitely spend the time to read those in-depth. Might be good for any that are "Likely Breaking" or have a bigger impact on previous code to list them at the top as well in. Maybe like the top 3 or something if it sin't a huge task to understand which may be the biggest issue. Appreciate all your comments on this. |
I think If a change ever broke everyone I don't think we'd ship it 😁 . |
It would appear that this version implements breaking changes into the http module. I am not really sure where it specifically is being brought up from but it woudl appear from
axios
orfollow-redirects
.Either way, from the minimal documentation on the error it would appear that this is likely due to no longer accepting
(undefined)
and only allowing()
somewhere?No clue
The text was updated successfully, but these errors were encountered: