From c489f340605ec58e4767d179dbda57ec92552c7c Mon Sep 17 00:00:00 2001
From: nanahi <130121847+na-na-hi@users.noreply.github.com>
Date: Thu, 16 May 2024 01:41:20 -0400
Subject: [PATCH] DOCS/compatibility.rst: require more details about breaking
 changes

Currently incompatible changes are not clearly outlined in the related
documentations, such as interface-changes.rst. The impacts and suggested
actions to address the compatibility concerns also rarely exist.

This adds a requirement to include these information for incompatible
changes, so that such changes are clearly conveyed to the users, with
suggested actions to minimize the impacts of such changes.
---
 DOCS/compatibility.rst | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/DOCS/compatibility.rst b/DOCS/compatibility.rst
index 42e66315b9..5ecec7f025 100644
--- a/DOCS/compatibility.rst
+++ b/DOCS/compatibility.rst
@@ -29,7 +29,9 @@ All of these are important for interfacing both with end users and API users
 (which include Lua scripts, libmpv, and the JSON IPC). As such, they constitute
 a large part of the user interface and APIs.
 
-All incompatible changes to this must be declared in interface-changes.rst.
+All incompatible changes to this must be declared in interface-changes.rst,
+which include the types of changes, the impact of these changes, and suggested
+actions to address such impact so that the incompatibility is alleviated.
 (This may also list compatible additions, but it's not a requirement.)
 
 Degrees of importance and compatibility preservation