From cc75038ccc7cb381ba07e11932106aa074cc17ff Mon Sep 17 00:00:00 2001 From: iequidoo Date: Fri, 17 Nov 2023 21:44:13 -0300 Subject: [PATCH] docs: Contributing guidelines for error handling --- CONTRIBUTING.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0285b2697..fe3e6df52 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -86,6 +86,11 @@ For example: .with_context(|| format!("Unable to trash message {msg_id}")) ``` +All errors should be handled in one of these ways: +- With `if let Err() =` (incl. logging them into `warn!()`/`err!()`). +- With `.log_err().ok()`. +- Bubbled up with `?`. + ### Logging For logging, use `info!`, `warn!` and `error!` macros.