diff --git a/doc/development/changelog.md b/doc/development/changelog.md index 616b175c9ebc952fbdfaaecf1236aa18b79ec3cd..5e659e368da064211b2d8a5aac0cb02f267fc273 100644 --- a/doc/development/changelog.md +++ b/doc/development/changelog.md @@ -20,14 +20,14 @@ automatically. The `Changelog` trailer accepts the following values: -- added -- fixed -- changed -- deprecated -- removed -- security -- performance -- other +- `added`: New feature +- `fixed`: Bug fix +- `changed`: Feature change +- `deprecated`: New deprecation +- `removed`: Feature removal +- `security`: Security fix +- `performance`: Performance improvement +- `other`: Other An example of a Git commit to include in the changelog is the following: