Simplify deprecation policy#4259
Conversation
nathan-contino
left a comment
nathan-contino
left a comment
There was a problem hiding this comment.
LGTM with a couple of questions -- up to you if you want to make any changes as a result.
| | 1.53.2 | April 15, 2024 | Feature documentation remains marked as deprecated. | None | | ||
| | 1.54.0 | May 15, 2024 | Feature documentation remains marked as deprecated. | None | | ||
| | 1.55.0 | July 13, 2024 | Feature and documentation removed. | Feature removal announced in release notes. | | ||
| * In a major release after the behavior is deprecated, the feature and corresponding documentation are removed. When the feature is removed, it is noted in the release notes. The documentation for the feature is also removed. |
There was a problem hiding this comment.
Does this mean 'one major release after' or is this a noncommittal 'some major release after'? It might be better to be explicit here.
| --- | ||
|
|
||
| FusionAuth is an architectural component integrated into your applications or systems. Such integration means that when changes to FusionAuth occur, it can negatively affect your application. As developers ourselves, we strive to maintain backwards compatibility. | ||
| FusionAuth is an architectural component integrated into your applications or systems. Such integration means that when changes to FusionAuth occur, it can negatively affect your application. As developers ourselves, we strive to maintain backwards compatibility. We will not remove API support in minor or patch versions (only in major versions), except for security/performance reasons noted below. |
There was a problem hiding this comment.
Considering we have only ever released one major version, should this instead say:
| FusionAuth is an architectural component integrated into your applications or systems. Such integration means that when changes to FusionAuth occur, it can negatively affect your application. As developers ourselves, we strive to maintain backwards compatibility. We will not remove API support in minor or patch versions (only in major versions), except for security/performance reasons noted below. | |
| FusionAuth is an architectural component integrated into your applications or systems. Such integration means that when changes to FusionAuth occur, it can negatively affect your application. As developers ourselves, we strive to maintain backwards compatibility. Only minor and major versions will change API support (never patch releases). |
suggestion: I always find it easier to understand conditionals like this when we avoid negatives
suggestion: if we extend this to 'major and minor', maybe we can omit the consideration about security and performance reasons?
nitpick: avoid slashes, preferring 'and' and 'or' when possible
| | 1.53.2 | April 15, 2024 | Feature documentation remains marked as deprecated. | None | | ||
| | 1.54.0 | May 15, 2024 | Feature documentation remains marked as deprecated. | None | | ||
| | 1.55.0 | July 13, 2024 | Feature and documentation removed. | Feature removal announced in release notes. | | ||
| * In a major release after the behavior is deprecated, the feature and corresponding documentation are removed. When the feature is removed, it is noted in the release notes. The documentation for the feature is also removed. |
There was a problem hiding this comment.
This is confusing to me because we don't do major releases. We only do minor and patch releases.
| * In a major release after the behavior is deprecated, the feature and corresponding documentation are removed. When the feature is removed, it is noted in the release notes. The documentation for the feature is also removed. | |
| * In a minor release after the behavior is deprecated, the feature and corresponding documentation are removed. When the feature is removed, it is noted in the release notes. The documentation for the feature is also removed. |
There was a problem hiding this comment.
I'd also prefer to keep the 3 month minimum timeframe, but I suppose that is an engineering decision.
|
@wied03 As far as I'm concerned, the wording of this policy is entirely engineering-owned, so let me know if you want to ship this as-is, or if you'd like to chat about the feedback that dan and I provided. Would like to keep this PR moving! |
3 participants
No description provided.