diff options
| author | Daphne Muller <86835268+DaphneMuller@users.noreply.github.com> | 2022-11-11 17:18:28 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-11-11 17:18:28 +0300 |
| commit | 8f24d6bf90cd93dfd10bb5050adc1e44cd2fa157 (patch) | |
| tree | 4c42cc391c30f3264803df24b7344adf9ff04088 | |
| parent | 9c3a3e011eeae27f884a02f8f414670fceb56913 (diff) | |
| parent | cb76210153ceaeda6af0074bf1e23bebd02e332f (diff) | |
Merge pull request #9322 from nextcloud/DaphneMuller-patch-1
Create compatibility_app_ecosystem.rst
| -rw-r--r-- | developer_manual/prologue/compatibility_app_ecosystem.rst | 31 | ||||
| -rw-r--r-- | developer_manual/prologue/index.rst | 1 |
2 files changed, 32 insertions, 0 deletions
diff --git a/developer_manual/prologue/compatibility_app_ecosystem.rst b/developer_manual/prologue/compatibility_app_ecosystem.rst new file mode 100644 index 000000000..f218d47ac --- /dev/null +++ b/developer_manual/prologue/compatibility_app_ecosystem.rst @@ -0,0 +1,31 @@ +==================================== +Compatibility with the app ecosystem +==================================== + +The Nextcloud app ecosystem consists of hundreds of apps and app maintainers. + +The development process may require changes that affect apps in this ecosystem. These changes may either be a change in standards or best practises, yet in more extreme cases the changes may also be breaking apps. + +While developers are expected to aim for limiting the number of changes that break apps, this cannot always be avoided or is not always reasonable to do to maintain an up-to-date technology stack. + +Informing app developers about any change that affect them is therefore key to a thriving ecosystem. This page describes the three procedures to document changes that are relevant to app developers. + + +Documentation procedures of changes that affect app developers +-------------------------------------------------------------- +There are three procedures in place to facilitate communication to app developers about changes that affect them: + + +1. The definition of done of a pull request includes documentation. +This means the development of your pull request cannot be considered done if you introduced changes that affect app developers that you did not document. + +2. A change that affects app developers, has to be reported and documented by the author of the pull request in the `Changes for developers and administrators issue <https://github.com/nextcloud/server/issues/34692>`_. +The requirements for this documentation are: + + - It should be written so that app developers understand how to work around the change for their app in a tutorial format + - The steps should be explicitly written, so the documentation shall not rely upon links to external resources for the steps. While it is encouraged to add an external links as additional reference, it is a hard requirement that the documentation is readable and actionable without browsing to this link. + - The documentation has to be carefully written. The author's name will be added to the final publication so readers can reach out to the author if they have questions or if something is unclear. + - Timeline: the documentation is required to be handed in immediately after merging the pull request. + + +3. The documentation will then be copy-pasted into the developer documentation and on the forum for the first beta release. diff --git a/developer_manual/prologue/index.rst b/developer_manual/prologue/index.rst index c065720a5..d18606f91 100644 --- a/developer_manual/prologue/index.rst +++ b/developer_manual/prologue/index.rst @@ -9,3 +9,4 @@ Prologue help_communication bugtracker/index security + compatibility_app_ecosystem |