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

docs: add BREAKING-CHANGES.md #538

Merged
merged 1 commit into from Sep 28, 2023
Merged

docs: add BREAKING-CHANGES.md #538

merged 1 commit into from Sep 28, 2023

Conversation

joshka
Copy link
Member

@joshka joshka commented Sep 27, 2023

Document the breaking changes in each version. This document is
manually curated by summarizing the breaking changes in the changelog.

@codecov
Copy link

codecov bot commented Sep 27, 2023

Codecov Report

Merging #538 (857082e) into main (61af0d9) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #538   +/-   ##
=======================================
  Coverage   89.65%   89.65%           
=======================================
  Files          41       41           
  Lines       11437    11437           
=======================================
  Hits        10254    10254           
  Misses       1183     1183           

@orhun
Copy link
Sponsor Member

orhun commented Sep 27, 2023

Should we update RELEASE.md about updating this file before release?

@joshka
Copy link
Member Author

joshka commented Sep 27, 2023

Should we update RELEASE.md about updating this file before release?

yes - done

BREAKING-CHANGES.md Outdated Show resolved Hide resolved
@kdheepak
Copy link
Collaborator

I think this should include this PR which I merged without proper conventional commit format: #456

@joshka
Copy link
Member Author

joshka commented Sep 28, 2023

I think this should include this PR which I merged without proper conventional commit format: #456

Also done

Document the breaking changes in each version. This document is
manually curated by summarizing the breaking changes in the changelog.
@joshka
Copy link
Member Author

joshka commented Sep 28, 2023

Rebased to clear conflicts with #526

@joshka joshka merged commit 4548a9b into main Sep 28, 2023
33 checks passed
@joshka joshka deleted the docs-breaking-changes branch September 28, 2023 08:00
tonogdlp pushed a commit to tonogdlp/ratatui that referenced this pull request Oct 6, 2023
Document the breaking changes in each version. This document is
manually curated by summarizing the breaking changes in the changelog.
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.

None yet

3 participants