Document new process for releasing breaking changes #7187
Merged
+91
−20
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
In a future PR, we will convert all peer dependencies to dependencies. When this happens, contributors need to follow a new process for ensuring that breaking changes do not cause problems for other developers or users. This PR adds the necessary documentation.
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
Mrtenz
requested changes
Nov 19, 2025
Member
Mrtenz
left a comment
Mrtenz
left a comment
There was a problem hiding this comment.
Looks good in general. Just some minor comments.
Member
There was a problem hiding this comment.
Maybe reference this from docs/contributing.md too?
docs/releasing-breaking-changes.md
Outdated
|
|
||
| ### 2. Audit dependent projects | ||
|
|
||
| Now that you've documented the affected symbols and exports in your package, locate all of the projects across MetaMask that use them. When you release your changes, how will those projects be affected? |
Member
There was a problem hiding this comment.
Maybe add something to make it clear that other dependent packages in core should also be audited.
Contributor
Author
There was a problem hiding this comment.
I have made some changes here, can you take a second look?
Gudahtt
reviewed
Nov 20, 2025
Gudahtt
reviewed
Nov 20, 2025
Gudahtt
reviewed
Nov 20, 2025
Member
Gudahtt
left a comment
Gudahtt
left a comment
There was a problem hiding this comment.
This looks great! Just had a few suggestions, this looks pretty close to ready though
Mrtenz
approved these changes
Nov 21, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Explanation
In a future PR, we will convert all peer dependencies to dependencies. When this happens, contributors need to follow a new process for ensuring that breaking changes do not cause problems for other developers or users. This PR adds the necessary documentation.
References
Closes https://consensyssoftware.atlassian.net/browse/WPC-132.
Checklist
Note
Introduces a breaking-changes process guide and updates contributor docs, reviewing guide, and PR template checklist to reference and align with it.
docs/breaking-changes.mddetailing what constitutes a breaking change and the process to document, audit dependents, and prepare upgrade PRs.docs/contributing.md):docs/reviewing-release-prs.md):breaking-changes.mdfor examples..github/pull_request_template.md):Written by Cursor Bugbot for commit c0a30da. This will update automatically on new commits. Configure here.