Skip to content

Commit

Permalink
docs: Create initial Versions documentation (#183)
Browse files Browse the repository at this point in the history
Motivated by related discussions during review of #168.

Signed-off-by: Michael Vorburger <mike@vorburger.ch>
  • Loading branch information
vorburger authored Aug 31, 2024
1 parent 567de9c commit 718992f
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions docs/versions.md
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit 718992f

Please sign in to comment.