[irods/irods#8605] Document Consortium's stance on API and ABI stability (main) #388

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open

korydraughn wants to merge 1 commit into irods:main from korydraughn:8605.m

docs/developers/api_abi_stability.md

-Original file line number
+Diff line change
@@ -0,0 +1,5 @@
+    # API and ABI Stability
+    The iRODS Consortium strives to maintain API stability and not break backward compatibility within a major version. This statement applies to stable public APIs only. Experimental features and projects which have not reached 1.0 status may experience breaking changes. Consumers of these features and projects must keep that in mind as they consider deploying them into production.
+    The iRODS Consortium DOES NOT make any guarantees around ABI stability. This applies to iRODS libraries written in C, C++, and other languages which compile to machine code.

mkdocs.yml

-Original file line number
+Diff line change
@@ Expand Up / @@ -77,6 +77,7 @@ nav: @@
         - Doxygen: 'doxygen/index.html'
         - Contributing: 'developers/contributing.md'
         - Development Tools: 'developers/development_tools.md'
+        - API and ABI Stability: 'developers/api_abi_stability.md'
         - Library Examples: 'developers/library_examples.md'
         - Logging: 'developers/logging.md'
         - Deprecation: 'developers/deprecation.md'
@@ Expand Down @@

Provide feedback