From 24a13bea0ae376695f17834b5201410e29209cbb Mon Sep 17 00:00:00 2001
From: Techassi <sascha.lautenschlaeger@stackable.tech>
Date: Wed, 17 Jan 2024 12:39:26 +0100
Subject: [PATCH 1/2] Add error variant name rule

---
 .../contributor/pages/code-style-guide.adoc   | 37 +++++++++++++++++++
 1 file changed, 37 insertions(+)

diff --git a/modules/contributor/pages/code-style-guide.adoc b/modules/contributor/pages/code-style-guide.adoc
index e192f2353..41823ae59 100644
--- a/modules/contributor/pages/code-style-guide.adoc
+++ b/modules/contributor/pages/code-style-guide.adoc
@@ -293,6 +293,43 @@ fn config_file(user: User) -> Result<(), Error> {
 
 ====
 
+=== Error variant names
+
+All error variants must not include any unnesecarry prefixes or suffixes.
+Examples of such prefixes include (but are not limited to) `FailedTo` and `UnableTo`.
+Furthermore, examples for suffixes are `Error` or `Snafu` 
+Error variant names must however include verbs or identifiers as a prefix.
+
+[WARNING.code-rule,caption=Examples of incorrect code for this rule]
+====
+
+[source,rust]
+----
+#[derive(Snafu)]
+enum Error {
+    FailedToParseConfig,
+    HttpRequestError,
+    ConfigRead,
+}
+----
+
+====
+
+[TIP.code-rule,caption=Examples of correct code for this rule]
+====
+
+[source,rust]
+----
+#[derive(Snafu)]
+enum Error {
+    ParseConfig,
+    HttpRequest,
+    ReadConfig,
+}
+----
+
+====
+
 === Error messages
 
 All our error messages must start with a lowercase letter and must not end with a dot.

From 5222a25e726160d504db9249a9814dcaa24c84ab Mon Sep 17 00:00:00 2001
From: Techassi <sascha.lautenschlaeger@stackable.tech>
Date: Wed, 17 Jan 2024 12:39:50 +0100
Subject: [PATCH 2/2] Adjust indentations for Rust code blocks

---
 .../contributor/pages/code-style-guide.adoc   | 48 +++++++++----------
 1 file changed, 24 insertions(+), 24 deletions(-)

diff --git a/modules/contributor/pages/code-style-guide.adoc b/modules/contributor/pages/code-style-guide.adoc
index 41823ae59..de64d8a78 100644
--- a/modules/contributor/pages/code-style-guide.adoc
+++ b/modules/contributor/pages/code-style-guide.adoc
@@ -246,12 +246,12 @@ The usage of `thiserror` is considered invalid.
 ----
 #[derive(thiserror::Error)]
 enum Error {
-  #[error("failed to read config file")]
-  FileRead(#[from] std::io::Error)
+    #[error("failed to read config file")]
+    FileRead(#[from] std::io::Error)
 }
 
 fn config_file(user: User) -> Result<(), Error> {
-  std::fs::read_to_string(user.file_path)?;
+    std::fs::read_to_string(user.file_path)?;
 }
 ----
 
@@ -259,12 +259,12 @@ fn config_file(user: User) -> Result<(), Error> {
 ----
 #[derive(Snafu)]
 enum Error {
-  #[snafu(context(false))]
-  FileRead { source: std::io::Error }
+    #[snafu(context(false))]
+    FileRead { source: std::io::Error }
 }
 
 fn config_file(user: User) -> Result<(), Error> {
-  std::fs::read_to_string(user.file_path)?;
+    std::fs::read_to_string(user.file_path)?;
 }
 ----
 
@@ -277,17 +277,17 @@ fn config_file(user: User) -> Result<(), Error> {
 ----
 #[derive(Snafu)]
 enum Error {
-  #[snafu(display("failed to read config file of user {user_name}"))]
-  FileRead {
-    source: std::io::Error,
-    user_name: String,
-  }
+    #[snafu(display("failed to read config file of user {user_name}"))]
+    FileRead {
+        source: std::io::Error,
+        user_name: String,
+    }
 }
 
 fn config_file(user: User) -> Result<(), Error> {
-  std::fs::read_to_string(user.file_path).context(FileReadSnafu {
-    user_name: user.name,
-  });
+    std::fs::read_to_string(user.file_path).context(FileReadSnafu {
+        user_name: user.name,
+    });
 }
 ----
 
@@ -342,14 +342,14 @@ It is recommended to start the error messages with "failed to..." or "unable to
 ----
 #[derive(Snafu)]
 enum Error {
-  #[snafu(display("Foo happened."))]
-  Foo,
+    #[snafu(display("Foo happened."))]
+    Foo,
 
-  #[snafu(display("Bar encountered"))]
-  Bar,
+    #[snafu(display("Bar encountered"))]
+    Bar,
 
-  #[snafu(display("arghh baz."))]
-  Baz,
+    #[snafu(display("arghh baz."))]
+    Baz,
 }
 ----
 
@@ -362,11 +362,11 @@ enum Error {
 ----
 #[derive(Snafu)]
 enum Error {
-  #[snafu(display("failed to foo"))]
-  Foo,
+    #[snafu(display("failed to foo"))]
+    Foo,
 
-  #[snafu(display("unable to bar"))]
-  Bar,
+    #[snafu(display("unable to bar"))]
+    Bar,
 }
 ----