Skip to content

Commit

Permalink
Docs about periods in log and error messages
Browse files Browse the repository at this point in the history
The recent documentation on log messages and error messages did not
clarify what the recommendations were about periods at the end of
the sentences.

This change clarifies that.

Signed-off-by: silvamatteus <silvamatteus@lsd.ufcg.edu.br>
  • Loading branch information
SilvaMatteus committed Nov 5, 2020
1 parent 4329911 commit 0bdd138
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -205,6 +205,8 @@ Log messages should make use of logging fields to convey additional information,
using string formatting which increases the cardinality of messages for log watchers to
look for and hinders aggregation.

Log messages and error messages should not end with periods.

## Mocks

Unit tests should avoid mock tests as much as possible. When necessary we should inject mocked
Expand Down

0 comments on commit 0bdd138

Please sign in to comment.