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

Create a UPGRADING.md document #11587

Closed
4 tasks
julienrbrt opened this issue Apr 8, 2022 · 1 comment · Fixed by #12477
Closed
4 tasks

Create a UPGRADING.md document #11587

julienrbrt opened this issue Apr 8, 2022 · 1 comment · Fixed by #12477
Assignees

Comments

@julienrbrt
Copy link
Member

Summary

In addition to the migration documentation, we should inspire ourselves from tendermint's UPGRADING.md and have one in this repo.

Problem Definition

What problems may be addressed by introducing this feature?

There is no clear documentation on how to upgrade version and use the new features apart from the migrations guide.

What benefits does the SDK stand to gain by including this feature?

The UPGRADING.md could be seen as a reference document for understanding the added changes and new features of a particular version of the SDK, without having to fully read the details of the migration guide.

For complete exhaustiveness of all the changes, the reference should still be the changelog, and for a brief overview the releases notes should be read.

Are there any disadvantages of including this feature?

Someone needs to go through the CHANGELOG.md before each release and update the upgrading guide, in additions to the migrations guide.

The disadvantage is negligible compared to the benefit added to developers.

Proposal

  • Create an UPGRADING.md in the repository
  • Let someone (a devrel?) each release make a guide from the CHANGELOG.md of the changes
  • Append the guide to the UPGRADING.md

For Admin Use

  • Not duplicate issue
  • Appropriate labels applied
  • Appropriate contributors tagged
  • Contributor assigned/self-assigned
@alexanderbez
Copy link
Contributor

I think such an idea can only help, so I'm all for it! 🙌

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

3 participants