Add a file to keep track of deprecated features

Descriptive text inspired by an analogous file used in the Commander.js repo.¹ ¹ <https://github.com/tj/commander.js/blob/f1ae2db8e2da01d6efcbfd59cbf82202f864b0c1/docs/deprecated.md>
nextstrain · Dec 20, 2023 · ebe4401 · ebe4401
1 parent 7474a2d
commit ebe4401
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/DEPRECATED.md b/DEPRECATED.md
@@ -0,0 +1,5 @@
+# Deprecated
+
+These features are deprecated, which means they are no longer maintained and
+will go away in a future major version of Augur. They are currently still
+available for backwards compatibility, but should not be used in new code.
diff --git a/docs/contribute/DEV_DOCS.md b/docs/contribute/DEV_DOCS.md
@@ -172,6 +172,9 @@ Versions for this project, Augur, from 3.0.0 onwards aim to follow the
       ```
 2. Define a new version number `X.X.X` based on changes and Semantic Versioning rules.
 
+    > [!NOTE]
+    > If releasing a major version, consider removing a [deprecated feature](../../DEPRECATED.md).
+
 ##### 2. Curate [CHANGES.md](../../CHANGES.md)
 
 1. Go through each PR and note the PRs that didn't provide an update to [CHANGES.md](../../CHANGES.md).