[PR #31] [CLOSED] remove inapplicable “Remember” in FAQ #2614

Closed
opened 2026-04-23 03:05:07 -05:00 by GiteaMirror · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/semver/semver/pull/31
Author: @roryokane
Created: 8/13/2012
Status: Closed

Base: masterHead: remove-remember-in-faq


📝 Commits (1)

  • 60792cf remove inapplicable “Remember” in FAQ

📊 Changes

1 file changed (+1 additions, -1 deletions)

View changed files

📝 semver.md (+1 -1)

📄 Description

What do I do if I accidentally release a backwards incompatible change as a minor version?

As soon as you realize that you've broken the Semantic Versioning spec, fix the problem and release a new minor version that corrects the problem and restores backwards compatibility. Remember, it is unacceptable to modify versioned releases, even under this circumstance. If it's appropriate, document the offending version and inform your users of the problem so that they are aware of the offending version.

I think “Remember” shouldn’t be there. Yes, I do remember this:

Once a versioned package has been released, the contents of that version MUST NOT be modified.

But I also remember this:

Major version X (X.y.z | X > 0) MUST be incremented if any backwards incompatible changes are introduced to the public API.

Those are both MUSTs. They are equally important. The premise of the question is that we’ve already broken one MUST – we’re in unknown, unregulated territory. It is not obvious that getting back to the spec shouldn’t involve breaking another MUST. “Remember” implies that it should have been obvious, but I think isn’t obvious – that sentence in the FAQ is new information, not a reminder. Thus, I think that sentence should be this:

It is unacceptable to modify versioned releases, even under this circumstance.

or perhaps this, which more explicitly acknowledges that the decision could have been made either way:

It remains unacceptable to modify versioned releases, even under this circumstance.


🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/semver/semver/pull/31 **Author:** [@roryokane](https://github.com/roryokane) **Created:** 8/13/2012 **Status:** ❌ Closed **Base:** `master` ← **Head:** `remove-remember-in-faq` --- ### 📝 Commits (1) - [`60792cf`](https://github.com/semver/semver/commit/60792cf12e66bfeeda750ab340de3992de1addac) remove inapplicable “Remember” in FAQ ### 📊 Changes **1 file changed** (+1 additions, -1 deletions) <details> <summary>View changed files</summary> 📝 `semver.md` (+1 -1) </details> ### 📄 Description > ### What do I do if I accidentally release a backwards incompatible change as a minor version? > > As soon as you realize that you've broken the Semantic Versioning spec, fix the problem and release a new minor version that corrects the problem and restores backwards compatibility. **Remember**, it is unacceptable to modify versioned releases, even under this circumstance. If it's appropriate, document the offending version and inform your users of the problem so that they are aware of the offending version. I think “Remember” shouldn’t be there. Yes, I do remember this: > Once a versioned package has been released, the contents of that version MUST NOT be modified. But I also remember this: > Major version X (X.y.z | X > 0) MUST be incremented if any backwards incompatible changes are introduced to the public API. Those are both MUSTs. They are equally important. The premise of the question is that we’ve already broken one MUST – we’re in unknown, unregulated territory. It is not obvious that getting back to the spec shouldn’t involve breaking another MUST. “Remember” implies that it should have been obvious, but I think isn’t obvious – that sentence in the FAQ is new information, not a reminder. Thus, I think that sentence should be this: > It is unacceptable to modify versioned releases, even under this circumstance. or perhaps this, which more explicitly acknowledges that the decision could have been made either way: > It **remains** unacceptable to modify versioned releases, even under this circumstance. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
GiteaMirror added the pull-request label 2026-04-23 03:05:07 -05:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/semver#2614