-
Notifications
You must be signed in to change notification settings - Fork 214
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: Update CHANGELOG.md to link to updated switch
example
#1582
Conversation
I was surprised to see the `=>` syntax described as 0.5.0, yet have it implemented in the current Playground. I would suggest that we use the "0.x.y - Unreleased" section to contain _everything_ that is currently implemented, even if it arrives prior to its "stated delivery date/release" in the Roadmap.
for more information, see https://pre-commit.ci
I agree with you and just commented on this in #1581. While I'm very much for the change, we need to figure something out about the release process and website updates. |
Move updated `switch` to 0.4.2, note that it's a breaking change; Remove mention of 0.5.0 version.
Adjust indentation
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
switch
exampleswitch
example
I think we can add a section to the template with |
I have seen the separate "Breaking Changes" section, but I have a sense that we should keep all the "features" (new or altered) together. They're what most people want/need to see. As I look at the 0.3.0 CHANGELOG entries, I would have placed all seven (three breaking, four new) items in the same group so they're seen as the "Big News" part of the release. All the rest of the 0.3.0 entries are careful reporting of other stuff that happened. By marking each of those three as Breaking change, that information stays with the feature description (and won't get lost if items get re-ordered). |
Uh oh... @TaxFairness (my alter-ego) responded. It was really me :-) |
I agree with your alter ego! |
This change was placed in 0.5.0 section because it is a breaking change, which cannot go into a patch release. The fact that playground & book immediately contained the change is a separate problem from #1507 |
Disregard that: semver states that "Major version zero (0.y.z) is for initial development. Anything MAY change at any time. The public API SHOULD NOT be considered stable." |
I'm glad to hear a citation for the rule (which makes complete sense). Thanks. |
for more information, see https://pre-commit.ci
Since the breaking change has been reverted, I removed the entry in the changelog, but kept the extended entry about Thanks for contributing. |
Good changes, thank you! |
I was surprised to see the
=>
syntax described as 0.5.0, yet have it implemented in the current Playground.I would suggest that we use the "0.x.y - Unreleased" section to contain everything that is currently implemented, even if it arrives prior to its "stated delivery date/release" in the Roadmap.