Skip to content

doc: info on handling unintended breaking changes #47426

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.

Sign up for GitHub

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

Merged
nodejs-github-bot merged 2 commits into from
Apr 9, 2023
Merged

doc: info on handling unintended breaking changes #47426

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6d93ab3
doc: info on handling unintended breaking changes
mhdawson Apr 5, 2023
4410a28
Update doc/contributing/collaborator-guide.md
mhdawson Apr 6, 2023
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
Update doc/contributing/collaborator-guide.md 
Co-authored-by: Mohammed Keyvanzadeh <mohammadkeyvanzade94@gmail.com>
  • Loading branch information
@mhdawson @VoltrexKeyva
mhdawson and VoltrexKeyva authored Apr 6, 2023
commit 4410a2875487061416f7c7794a8e5b61b07d7b83
2 changes: 1 addition & 1 deletion doc/contributing/collaborator-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -394,7 +394,7 @@ If the change is reverted make sure to:
* consider if adding packages to CITGM would have helped catch
the breaking change.
* ensure the changelog with the revert clearly explains the situation and
it's impact on those who may have already used the udpated API.
it's impact on those who may have already used the updated API.

In either case make sure that the documentation and changelog for the
original breaking change are updated to reflect the breaking behavior.
Expand Down