docs: CHANGES and other misc docs changes from the 3.1 release (#4918)

lgritz · web-flow · commit 046b20f60597 · 2025-10-02T18:42:56.000-07:00
Forward-porting some docs touch-ups that were part of the 3.1 release
staging.

Signed-off-by: Larry Gritz &lt;lg@larrygritz.com&gt;
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -406,8 +406,8 @@ jobs:
             pybind11_ver: v3.0.0
             simd: "avx2,f16c"
             skip_tests: 1
-            # abi_check: v3.1.3.0
-            abi_check: 9bfcce725a3806a3f70c7e838d9d98d6d95c917a
+            # abi_check: v3.1.6.0
+            abi_check: d4c8024633dba8bb3c01d22b65ce9bc7a1ae215e
             setenvs: export OIIO_CMAKE_FLAGS="-DOIIO_BUILD_TOOLS=0 -DOIIO_BUILD_TESTS=0 -DUSE_PYTHON=0"
                             USE_OPENCV=0 USE_FFMPEG=0 USE_PYTHON=0 USE_FREETYPE=0
             optional_deps_append: "openjph;Qt6"
diff --git a/CHANGES.md b/CHANGES.md
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,37 +1,29 @@
 Contributing to OpenImageIO
 ===========================
 
-> NOTE: This is the proposed post-ASWF-move version of CONTRIBUTING. After the
-> project is legally transferred and moved to the new repo, this file will
-> replace the one at the project root.
->
-> TO DO:
->
-> - [X] Update the mail list sign-up page after the mail list moves.
-> - [ ] Update the repo URL
-> - [ ] Double check the security and info email addresses.
->
-
-Code contributions to OpenImageIO are always welcome, and [nearly 200
+Code contributions to OpenImageIO are always welcome, and [nearly 250
 people](https://github.com/AcademySoftwareFoundation/OpenImageIO/blob/main/CREDITS.md) have done
 so over the years.  Please review this document to get a briefing on our
 process.
 
 
+General Tips for Open Source Development
+----------------------------------------
+
+* GitHub's [Open Source Guides](https://opensource.guide/)
+  - Especially the guide on [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)
+
+
 Mail List and Slack
 -------------------
 
-Contributors should be reading the oiio-dev mail list:
-
 * [oiio-dev](https://lists.aswf.io/g/oiio-dev)
 For developers of the OpenImageIO code itself, or users who are really
 interested in the OIIO internals. This is where we mostly discuss the code
 (including bug reports), but are also happy to answer user questions about
-use or working of OIIO.
-
-You can sign up for the mail list on your own using the link above.
+use or working of OIIO. You can sign up for the mail list on your own using the link above.
 
-The [ASWF Slack](https://slack.aswf.io/) has an `openimageio` channel. Sign up
+* [ASWF Slack](https://slack.aswf.io/) has an `openimageio` channel. Sign up
 for the Slack on your own, then under "channels", select "browse channels" and
 you should see the openimageio channel (among those of the other projects and
 working groups).
@@ -55,7 +47,7 @@ enhancements: https://github.com/AcademySoftwareFoundation/OpenImageIO/issues
 
 **If you are merely asking a question ("how do I...")**, please do not file an
 issue, but instead ask the question on the [oiio-dev mailing
-list](https://lists.aswf.io/g/oiio-dev).
+list](https://lists.aswf.io/g/oiio-dev) or on the Slack channel.
 
 If you are submitting a bug report, please be sure to note which version of
 OIIO you are using, on what platform (OS/version, which compiler you used,
@@ -215,7 +207,7 @@ under `fix:`, because that appears first in the list).
 It is also encouraged, when it makes sense to do so, to put a subcategory in
 parenthesis after the prefix, like `fix(exr):` or `feat(IBA):`. It's ok to use
 obvious abbreviations for major classes or subsections: IB=ImageBuf,
-IBA=ImageBufAlgo, IC=ImageCace, TS=TextureSystem, etc. If there is no clear
+IBA=ImageBufAlgo, IC=ImageCache, TS=TextureSystem, etc. If there is no clear
 single format or class that is the man focus of the patch, then you can omit
 the subcategory.
 
diff --git a/CREDITS.md b/CREDITS.md
@@ -48,6 +48,7 @@ lg@openimageio.org
 * Brian Hall
 * Brice Gros
 * Campbell Barton
+* Carine Touraille
 * Carl Rand
 * Cassian Andrei
 * Chad Dombrova
@@ -61,6 +62,7 @@ lg@openimageio.org
 * Christoph Willing
 * Clément Champetier
 * Cliff Stein
+* Connie Chang
 * Curtis Black
 * D-Spirits
 * Dalai Felinto
@@ -180,6 +182,7 @@ lg@openimageio.org
 * Nuno Cardoso
 * Oktay Comu
 * Ole Gulbrandsen
+* omcaif
 * Ott Tinn
 * Pascal Lecocq
 * Patrick Hodoul
diff --git a/README.md b/README.md
@@ -136,7 +136,7 @@ security-related issues [security@openimageio.org](security@openimageio.org).
 🔧 Contributing and developer documentation
 -------------------------------------------
 
-OpenImageIO welcomes code contributions, and [nearly 200 people](CREDITS.md)
+OpenImageIO welcomes code contributions, and [nearly 250 people](CREDITS.md)
 have done so over the years. We take code contributions via the usual GitHub
 pull request (PR) mechanism.
 
@@ -155,6 +155,11 @@ pull request (PR) mechanism.
   building the documentation locally, which may be helpful if you are editing
   the documentation in nontrivial ways and want to preview the appearance.
 * Other developer documentation is in the [docs/dev](docs/dev) directory.
+* You may also have luck learning a bit about the organization and
+  architecture of the project by reading the [DeepWiki Analysis of
+  OpenImageIO](https://deepwiki.com/AcademySoftwareFoundation/OpenImageIO).
+  But take it with a grain of salt -- like any LLM-generated summary, there
+  may be inaccuracies lurking.
 
 
 ☎️ Communications channels and additional resources
diff --git a/SECURITY.md b/SECURITY.md
@@ -9,9 +9,8 @@ security vulnerabilities.
 | ----------------- | ---------------------------------------------------- |
 | main              | :white_check_mark: :construction: ALL fixes immediately, but this is a branch under development with a frequently unstable ABI and occasionally unstable API. |
 | 3.1.x             | :white_check_mark: All fixes that can be backported without breaking ABI compatibility. New tagged releases monthly. |
-| 3.0.x             | :white_check_mark: All fixes that can be backported without breaking ABI compatibility. New tagged releases monthly. |
-| 2.5.x             | :warning: Bug fixes backported only if critical or upon request (and if we are able to cleanly backport). New tagged releases only occasionally. |
-| < 2.5.x          | :x: No longer receiving patches of any kind.        |
+| 3.0.x             | :warning: Important fixes that can be easily backported without breaking ABI compatibility. New tagged releases as needed, and becoming less frequent over time. |
+| <= 2.5.x         | :x: No longer receiving patches of any kind.        |
 
 
 ## Reporting a Vulnerability
diff --git a/docs/dev/RELEASING.md b/docs/dev/RELEASING.md
@@ -325,7 +325,7 @@ The following are the steps for making the release:
     > The API is now frozen -- we promise that subsequent 3.1.x releases
     > (which should happen monthly) will not break back-compatibility of API,
     > ABI, or linkage, compared to this release. Please note that this release
-    > is *not* ABI or link compatible with 2.5 or older releases.
+    > is *not* ABI or link compatible with 3.0 or older releases.
     > 
     > Release notes for 3.1 outlining all the changes since last year's
     > release can be found at *LINK TO THE GITHUB RELEASE PAGE.*
@@ -347,15 +347,15 @@ The following are the steps for making the release:
     > releases to the 3.1 family roughly monthly, which will contain bug fixes
     > and non-breaking enhancements.
     > 
-    > The older 2.5 series of releases is now considered obsolete. We will
-    > continue for now to make 2.4 patch releases, but over time, these will
+    > The older 3.0 series of releases is now considered obsolete. We will
+    > continue for now to make 3.0 patch releases, but over time, these will
     > become less frequent and be reserved for only the most critical bug
     > fixes.
     > 
-    > The "main" branch is now progressing toward an eventual 3.1 release next
+    > The "main" branch is now progressing toward an eventual 3.2 release next
     > fall. As usual, you are welcome to use main for real work, but we do
     > not make any compatibility guarantees and don't guarantee continuing API
-    > compatibility in main.
+    > compatibility within main.
     >
     > (Paste the full set of 3.1 changes here, just copy the appropriate
     > part of CHANGES.md)
