Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Neutralize gender in logging guidelines #1068

Merged
merged 1 commit into from
Oct 28, 2019
Merged

Neutralize gender in logging guidelines #1068

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions developers/guidelines.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -186,11 +186,11 @@ It should be up to the user to increase the logging level for specific bundles,
This means in detail:

* `error` logging should only be used
- to inform the user that something is tremendously wrong in his setup, the system cannot function normally anymore, and there is a need for immediate action.
- to inform the user that something is tremendously wrong in the setup, the system cannot function normally anymore, and there is a need for immediate action.
- in case some code fails irrecoverably and the user should report it as a severe bug.

* `warn` logging should only be used
- to inform the user that something seems to be wrong in his overall setup, but the system can nonetheless function as normal,
- to inform the user that something seems to be wrong in the overall setup, but the system can nonetheless function as normal,
- in recoverable situations when a section of code that is not accessed under normal operating conditions is reached.

* `info` logging should be used sparsely.
Expand Down