You can deprecate a feature or a component once:
- an alternative exists.
- the support for the given functionality is scheduled for termination
The deprecated component should be marked as follows:
/**
* @deprecated - This UI component will be removed in the next major release. This component is deprecated because <XY>.
* For more information see [docs link](https://....)
*
* FixedHeightMessage - This component renders a single message.
* It uses fixed height elements to make sure it works well in VirtualizedMessageList
*/- Deprecated component:
- does not receive an alternative -> update the documentation on how to implement the deprecated feature.
- receives an alternative -> update the documentation on how to use the introduced alternative solution.
- Commit the changes under
deprecatecommit type, with commit description stating the reasons for deprecation. - Create an issue, so it can be scheduled for removal in foreseeable future. Tag the issue with the label
breaking.