Feathers UI semantic versioning
Feathers UI aims to follow semantic versioning for all public APIs, meaning that all updates will follow these basic guidelines:
- Breaking changes must be limited to major version updates.
- New features that don't break backwards compatibility may be included in either major or minor version updates.
- A patch update must contain only bug fixes that are backwards compatible.
Any type (class, interface, enum) or member (method, field, property) that is documented in the Feathers UI API reference is considered to be a public API. In this sense, it is not necessarily required for an API to use the
public access modifier. Any API could be considered a public API, even if it uses the
private access modifier, as long as it is documented.
If an API is undocumented, it isn't consided a public API, and it should be treated as internal implementation detail. These internal APIs are subject to change in any type of update, without notice or deprecation. Call or override undocumented APIs at your own risk.
If you believe that any internal API should be upgraded to become a public API, please submit a feature request with a detailed explanation of how and why you want to use it.
If a new public API is added, it may be marked as a beta API, meaning that it is not yet subject to the guidelines of semantic versioning. Breaking changes in beta APIs may not be limited to only major updates. They may also be included in minor updates too. When an API is upgraded to no longer be considered beta, that's when it will start being subject to semantic versioning.
When a public API is subject to removal, it must first be deprecated. When an API is deprecated, the compiler or IDE will typically display a warning message about this change of status, which will give some kind of hint about how code should be updated. Generally, a replacement API will be made available, and it will be possible to switch to the replacement API before the next major version, when the deprecated API will be removed completely.
Members of beta or deprecated types
If a type, such as a
enum, is considered to be deprecated or beta, all of its members (such as methods, fields, or properties) will have the same status.
Lets say that a public property named
oldAndBusted is deprecated in version 1.1, in favor of its replacement, an improved public property named
newHotness will exist side by side in all future 1.x.y minor and patch updates. The compiler will display a deprecation notice when
oldAndBusted is referenced in code, and this notice will encourage developers to migrate to
newHotness. When verison 2.0 is released,
oldAndBusted will be removed, and all developers will be required to migrate to