This is an automated email from the ASF dual-hosted git repository.
asf-gitbox-commits pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/sis-site.git
The following commit(s) were added to refs/heads/main by this push:
new 92112fff Add a note about API stability.
92112fff is described below
commit 92112fff1c624aa71306003ead8a1cfbfd7c9bc7
Author: Martin Desruisseaux <[email protected]>
AuthorDate: Thu May 7 10:24:22 2026 +0200
Add a note about API stability.
---
content/_index.md | 9 +++++++++
1 file changed, 9 insertions(+)
diff --git a/content/_index.md b/content/_index.md
index 7b1ea591..17124a79 100644
--- a/content/_index.md
+++ b/content/_index.md
@@ -80,6 +80,15 @@ A [command-line tool](command-line.html) and a [JavaFX
application](javafx.html)
are also provided for allowing users to experiment some SIS functionalities
before writing code.
+## Backward compatibility policy {#compatibility}
+
+Most of SIS public API is stable.
+If an API needs to be changed, the old API is annotated as deprecated and a
Javadoc comment explains the replacement.
+If the API is deprecated for removal, it is usually kept for only one release
and effectively removed in the next one.
+Therefore, if an API seems to have disappeared after an Apache SIS upgrade,
the migration path can be identified by
+incrementing the version one-by-one. The `@version` tag gives the last version
when a class got a significant change.
+
+
[geoapi]: https://www.geoapi.org/
[GML]: https://www.ogc.org/standards/gml
[SF_SQL]: https://www.ogc.org/standards/sfs
