Skip to content
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

Draft an UPGRADES.md #3791

Closed
rootulp opened this issue Aug 19, 2024 · 0 comments · Fixed by #3794
Closed

Draft an UPGRADES.md #3791

rootulp opened this issue Aug 19, 2024 · 0 comments · Fixed by #3794
Assignees

Comments

@rootulp
Copy link
Collaborator

rootulp commented Aug 19, 2024

Context

We're currently working on a few PRs with breaking changes for v3.

Problem

There currently is no way to document the v3 breaking changes for node operators / library consumers in the breaking PR.

Proposal

  1. Create a file like UPGRADES.md that can contain notes for node operators + library consumers who are upgrading through major versions.
  2. Describe enabling BBR in v2 and/or v3
  3. Add notes from 2 recent breaking PRs in v3
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant