RepoMirrors
/
mpv
mirror of https://github.com/mpv-player/mpv
1
0
Fork 0
Code Issues Releases Wiki Activity

DOCS/contribute.md: require interface change begin with type 

This makes interface changes appear sorted with the types of changes,
making it easier for users to find breaking changes among all changes.
This commit is contained in:
nanahi 2024-05-21 00:28:02 -04:00 committed by Kacper Michajłow
parent 1a5edb1e49
commit 20bd4483b1
1 changed files with 4 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
DOCS/contribute.md
View File

@ -141,7 +141,10 @@ Interface change policy
must be documented by making a new text file with a txt extension containing a
small note in the DOCS/interface-changes directory.
- The name of the file should be brief and related to the commit that makes the
change.
change. The content of the file should begin with the type of the change
(add, remove, deprecate, change, rename, etc.). If the file contains multiple
changes, the change which causes the most serious compatibility issues should
be placed first.
- Grouping multiple related changes in the same file is also OK. Just be sure to
put each separate change on a different line.
- Documenting additions in DOCS/interface-changes is optional but encouraged.