From b2fa9988b9b632073e5a72247c50d37011f8acb8 Mon Sep 17 00:00:00 2001 From: Otto Bittner Date: Mon, 21 Aug 2023 16:48:10 +0200 Subject: [PATCH] docs: add note on how we handle deprecations (#2185) --- dev-docs/workflows/deprecations.md | 10 ++++++++++ 1 file changed, 10 insertions(+) create mode 100644 dev-docs/workflows/deprecations.md diff --git a/dev-docs/workflows/deprecations.md b/dev-docs/workflows/deprecations.md new file mode 100644 index 000000000..d224b0550 --- /dev/null +++ b/dev-docs/workflows/deprecations.md @@ -0,0 +1,10 @@ +# Deprecations + +When removing a feature/flag/command we strive to mark said feature as deprecated one minor version before the removal happens. +I.e. to remove the CLI command `foo` in version v10.6, all invocations of `foo` in v10.5 should print a deprecation warning. +The deprecation should also be noted in the help text of the command to make it show up in the Constellation docs. + +The changelog for v10.5 should contain a deprecation warning for `foo`. +The changelog for v10.6, should sort the removal of `foo` in the category `Breaking Changes`. + +It may happen that the effort to implement a feature in this manner is deemed to high.