Skip to content

Commit

Permalink
Changelog edits
Browse files Browse the repository at this point in the history
  • Loading branch information
arturmuller committed Jul 3, 2024
1 parent 6b6453f commit 2964a98
Showing 1 changed file with 3 additions and 4 deletions.
7 changes: 3 additions & 4 deletions Changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

This document maintains a list of major changes to Superstruct with each new release.

### `2.0.0` - July 2, 2024
### `2.0.0` - July 3, 2024

Some changes in Superstruct 2.0.0 are *potentially* breaking if you were using the library in unusual and/or undocumented ways. Since it has been almost 2 years since the last release, we want to make sure that we don't ruin someone's day by surprising them with a fix that changes [buggy behaviour they were relying on](https://xkcd.com/1172/). For this reason, some changes that would ordinarily be consider a fix are marked as breaking.
Some changes in Superstruct v2.0 are _potentially_ breaking if you were using the library in unusual and/or undocumented ways. Since it has been almost 2 years since the last significant release, we want to make sure that we don't ruin someone's day by surprising them with a fix that changes [buggy behavior they were relying on](https://xkcd.com/1172/). For this reason, some changes that would ordinarily be considered a fix are marked as breaking.

**:rocket: For the absolute majority of users, this should be a smooth upgrade that will not require any changes.**

Expand All @@ -29,13 +29,12 @@ Some changes in Superstruct 2.0.0 are *potentially* breaking if you were using t

Project maintenance has moved to a new volunteer team: [@arturmuller](https://github.com/arturmuller) and [@yeoffrey](https://github.com/yeoffrey). Hello there! :wave: We are currently going through the existing issues and PRs, trying to resolve or close the backlog. This might take a little while so please bear with us.

If you are interested in **contributing** — or helping us process the backlog — we would love your help. Don't hesitate to help us triage, open an issue, or submit a PR. You can also join our Superstruct maintainers Discord: https://discord.gg/pdHrQBjQ96
If you are interested in **contributing** — or helping us process the backlog — we would love your help. Don't hesitate to help us triage, open an issue, or submit a PR. You can also join our Superstruct maintainers Discord: https://discord.gg/pdHrQBjQ96.

If you have **questions, suggestions, or are just not sure about something** related to Superstruct, head over to GitHub Discussions! We have recently enabled this feature to help us differentiate between actual issues/bugs and everything else. We hope this will be a great new place where Superstruct users can get quick help from us — the maintainers — but also from the community as a whole.

See you at the next release! :v:


### `1.0.0` — November 17, 2022

###### NEW
Expand Down

0 comments on commit 2964a98

Please sign in to comment.