diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c082ee271b..9717e1b00b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -191,7 +191,7 @@ Deprecations become breaking changes after notifying developers through deprecat - `5.0.0` marks the beginning of logging the deprecation warning for one entire major release - `6.0.0` makes the breaking change by removing the deprecation warning and making the new feature replace the existing feature -Developer feedback during the deprecation period may further postpone the introduction of a breaking change. +Developer feedback during the deprecation period may further postpone the introduction of a breaking change. The [Deprecation Plan](https://github.com/parse-community/parse-server/blob/master/DEPRECATIONS.md) gives an overview of deprecations and planned breaking changes. ## Feature Considerations ### Security Checks diff --git a/DEPRECATIONS.md b/DEPRECATIONS.md new file mode 100644 index 0000000000..632ae9ca83 --- /dev/null +++ b/DEPRECATIONS.md @@ -0,0 +1,12 @@ +# Deprecation Plan + +The following is a list of deprecations, according to the [Deprecation Policy](https://github.com/parse-community/parse-server/blob/master/CONTRIBUTING.md#deprecation-policy). After a feature becomes deprecated, and giving developers time to adapt to the change, the deprecated feature will eventually be removed, leading to a breaking change. Developer feedback during the deprecation period may postpone the introduction of the breaking change. + +| Feature | Issue | Deprecation [ℹ️][i_deprecation] | Planned Removal [ℹ️][i_removal] | Status [ℹ️][i_status] | Notes | +|---------|----|------------------|----------------------|----------|-------| +(none) + + +[i_deprecation]: ## "The version and date of the deprecation." +[i_removal]: ## "The version and date of the planned removal." +[i_status]: ## "The current status of the deprecation: deprecated (the feature is deprecated and still available), removed (the deprecated feature has been removed and is unavailable), retracted (the deprecation has been retracted and the feature will not be removed." \ No newline at end of file