hohn/codeql
1
0
Fork 0
mirror of https://github.com/github/codeql.git synced 2025-12-16 08:43:11 +01:00
Code Issues Packages Projects Releases Wiki Activity

Docs: Document preference for American English in change notes.

Browse Source
This commit is contained in:
Alexandre Boulgakov
2024-07-23 13:49:30 +01:00
parent ff8bb2b1f8
commit 5e6c9fb661
1 changed files with 2 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/change-notes.md
View File

@@ -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.