diff --git a/Documentation/contributing.rst b/Documentation/contributing.rst index fbe34a01..495bfb31 100644 --- a/Documentation/contributing.rst +++ b/Documentation/contributing.rst @@ -38,7 +38,26 @@ room: Source Code ----------- -libcamera is in early stages of development, and no releases are available yet. +libcamera is in active development, including investigations into what a 'good' +API is for the implementation. We can't guarantee we have all features +implemented, or designed correctly yet, and we have plans to make considerable +changes to the API and ABI in our roadmap. + +Even so, we provide periodic 'releases' to support distributions and packaging +teams. To support this we are currently making releases of the 0.y.z version +scheme, loosely following semver. + +In the foreseeable future, the following applies: + + 0.y.z : Active development, but with ABI breakage detection. The 0.y + version will bump on an ABI/API breakage. Ongoing development will + increment the .z version component. Therefore, pre 1.0 'y' is a + close equivalent to a major release. + + 1.y.z : Stable API and ABI guarantees on the Major version number. + Following semantic versioning as documented at https://semver.org/ + + The source code is available from the project's `git tree`_. .. code-block:: shell @@ -47,9 +66,13 @@ The source code is available from the project's `git tree`_. .. _git tree: https://git.libcamera.org/libcamera/libcamera.git/ -A mirror is also hosted on `LinuxTV`_. +A development mirror is also hosted on `Freedesktop`_. -.. _LinuxTV: https://git.linuxtv.org/libcamera.git/ +.. _Freedesktop: https://gitlab.freedesktop.org/camera/libcamera + +Freedesktop also provides our CI and `testing pipeline`_. + +.. _testing pipeline: https://gitlab.freedesktop.org/camera/libcamera/-/pipelines Issue Tracker -------------