From 0efd7e3c8e11d82979c8557943d3682d17e01760 Mon Sep 17 00:00:00 2001 From: Michael Vorburger Date: Fri, 30 Aug 2024 12:41:40 +0200 Subject: [PATCH] docs: Create initial Versions documentation Motivated by related discussions during review of #168. Signed-off-by: Michael Vorburger --- docs/versions.md | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 docs/versions.md diff --git a/docs/versions.md b/docs/versions.md new file mode 100644 index 000000000..277e22dbf --- /dev/null +++ b/docs/versions.md @@ -0,0 +1,11 @@ +# Versions & Backwards Compatibility + +This project "versions" external nullness annotations for public & protected API surfaces of common Java libraries. + +In some cases we maintain both older & newer versions; e.g. for the JDK, or the Servlet API in `javax` and `jakarta` packages, etc. + +In other cases in our next major version release we may remove old versions of libararies which we believe to longer be used much. + +Of course, you can always use already stable past versions released to Maven central, even if we've cleaned them out at source. + +Contributions for additional versions which you need in your projects are always welcome.