mirror of
https://github.com/HackPlan/polaris-react.git
synced 2026-01-12 22:44:36 +08:00
1f46b9a759
Deprecation guidelines mention that contributors should add a console warning for deprecated tags. This PR adds a link to guidelines that will help the contributor write a good console message.
1.5 KiB
1.5 KiB
Deprecation guidelines
- Ship backwards compatible changes which include supporting both the old and new API (make sure the full upgrade path is available)
- Support backwards compatibility for at least half of a major release cycle, but never more that 2 major release cycles
- For example, before or part of 3.5, okay to remove in 4.0. After 3.5, remove in 5.0
- Large changes consider a full major release cycle. For example, a large change in 3.1 would be removed in 5.0. But a large change in 2.9 would never wait until 5.0 to remove
- Use the
@deprecateddoc tag for props and components (for example, add above where the component is defined), state the reason, and upgrade path - Add a console warning for any respective
@deprecateddoc tag, state the reason, and state the upgrade path- Add the console warning in the constructor for classes and in the render method for functional components
- Guidelines for writing good console messages
- For significant deprecations, add a section to the component documentation with rationale. State the upgrade path and include a link to a new component if applicable
- Call out deprecations in our changelog