From 5e6c9fb661a82a5894b5adfeb840dd23e61cfbee Mon Sep 17 00:00:00 2001 From: Alexandre Boulgakov Date: Tue, 23 Jul 2024 13:49:30 +0100 Subject: [PATCH] Docs: Document preference for American English in change notes. --- docs/change-notes.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/change-notes.md b/docs/change-notes.md index b48f56863c4..7bf33447f6e 100644 --- a/docs/change-notes.md +++ b/docs/change-notes.md @@ -44,6 +44,8 @@ The valid YAML properties in the metadata are: ### Description After the `---` line following the metadata, the rest of the markdown file is the user-visible content of the change note. This should usually be a single markdown bullet list entry (starting with `*`), although it is acceptable to have multiple bullet entries in the same change note if there are multiple changes that are closely related and have the same category metadata. +For consistency, change notes should use American English. + ## Change categories Each change note must specify a `category` property in its metadata. This category servers two purposes: It determines how the change affects the version number of the next release of the pack, and it is used to group related changes in the final changelog. There is one set of available categories for query packs, and another set of available categories for library packs.