From fda07aa45d5f20b7c5583c9965fc35f49911d0c3 Mon Sep 17 00:00:00 2001 From: Manuel <5673677+mtrezza@users.noreply.github.com> Date: Tue, 10 Aug 2021 22:55:16 +0200 Subject: [PATCH] Add deprecation plan (#7485) * add deprecation plan * Update DEPRECATIONS.md --- CONTRIBUTING.md | 2 +- DEPRECATIONS.md | 12 ++++++++++++ 2 files changed, 13 insertions(+), 1 deletion(-) create mode 100644 DEPRECATIONS.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c082ee27..9717e1b0 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 00000000..632ae9ca --- /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