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.

nanahi committed 2 years ago

Commit 20bd4481 parent 1a5edb11 file · +4 −1Browse files

Unified · Split

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

Keyboard shortcuts