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

chore: improve UGPRADING.md #15236

Merged
merged 5 commits into from
Mar 2, 2023
Merged

chore: improve UGPRADING.md #15236

merged 5 commits into from
Mar 2, 2023

Conversation

julienrbrt
Copy link
Member

@julienrbrt julienrbrt commented Mar 1, 2023

Description

Follow-up of #15211

  • Add changelog
  • Fix proto lint
  • Reword UPGRADING.md

Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

  • included the correct type prefix in the PR title
  • added ! to the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • followed the guidelines for building modules
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • included comments for documenting Go code
  • updated the relevant documentation or specification
  • reviewed "Files changed" and left comments if necessary
  • confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed ! in the type prefix if API or client breaking change
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic
  • reviewed API design and naming
  • reviewed documentation is accurate
  • reviewed tests and test coverage
  • manually tested (if applicable)

@julienrbrt julienrbrt changed the title chore: clean-up of #15211 chore: improve UGPRADING.md Mar 1, 2023
@julienrbrt julienrbrt marked this pull request as ready for review March 1, 2023 22:52
@julienrbrt julienrbrt requested a review from a team as a code owner March 1, 2023 22:53
@@ -6,25 +6,26 @@ This guide provides instructions for upgrading to specific versions of Cosmos SD

### Migration to CometBFT (Part 2)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: can we combine the two migration to comet bft sections into one?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Part 2 is unreleased and Part 1 is under v0.47, so I don't think so?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

oh i thought what is on main is also used in 0.47 so it seemed to be overlapping.

Oh these are items we changed in our repo. Kind of confusing

Copy link
Member Author

@julienrbrt julienrbrt Mar 2, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't really follow. There were some thing repetitive from the other PR, but I've removed it here.
There is indeed some categories that are the same between unreleased and v0.47, but this is because we've changed more things after v0.47 had its scope fixed. So this is why it is under unreleased.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it was mainly confusing to see part 1 and part 2 but they are not in the same release and have two different scopes.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can reword. As it was both related I thought it was clear. I am not sure how to name the "Part 2" otherwise, as I feel like it's still clearly related.

UPGRADING.md Outdated Show resolved Hide resolved
Co-authored-by: Marko <marbar3778@yahoo.com>
@julienrbrt julienrbrt merged commit de16912 into main Mar 2, 2023
@julienrbrt julienrbrt deleted the julien/followup-15211 branch March 2, 2023 10:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants