exceptionfactory commented on code in PR #6390: URL: https://github.com/apache/nifi/pull/6390#discussion_r970039560
########## nifi-docs/src/main/asciidoc/developer-guide.adoc: ########## @@ -2637,19 +2637,83 @@ logged to help avoid this bad practice. [[deprecation]] -== Deprecating a Component +== Deprecating Components and Features +Deprecating features is an important part of the software development lifecycle, providing an upgrade path for +developers and users to follow. + +Apache NiFi follows the link:https://semver.org[Semantic Versioning Specification 2.0.0^] for features identified as +part of the public version contract according to +link:https://cwiki.apache.org/confluence/display/NIFI/Version+Scheme+and+API+Compatibility[Version Scheme] +documentation. + +Components and features that fit under the public version contract require deprecation marking prior to removal. This +approach allows developers to implement changes as part of minor version upgrades, in preparation for future removal +of features in a subsequent major version. Review Comment: In the larger context of this section, this references to removing features that would cause breaking changes. That is the reason for the opening sentence referencing "features that fit under the public version contract." There may be some theoretical edge case where a feature needs to be removed for some other reason, like a security vulnerability, but this sentence states the standard approach. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
