diff --git a/docs/development/best-practices.md b/docs/development/best-practices.md index b10928dd02ea10e2885f8bce430236df772305c9..88ef157ec755d471a3b6376419ff609cb3b96728 100644 --- a/docs/development/best-practices.md +++ b/docs/development/best-practices.md @@ -162,7 +162,7 @@ Also inline the metadata if the metadata object is complex. `WARN`, `ERROR` and `FATAL` messages are often used in metrics or error catching services. These log messages should have a consistent `msg` component, so they can be automatically grouped or associated. -Metadata that's seperate from its message is hard for humans to read. +Metadata that's separate from its message is hard for humans to read. Try to combine the metadata into the message, unless it's too complex to do so. Good: