From 7641b4da6fe3762bbb9a7c23e0c398a3afbdad1a Mon Sep 17 00:00:00 2001 From: Dorota Czaplejewicz Date: Wed, 11 Dec 2019 15:33:29 +0000 Subject: [PATCH] Create a library/UI module separation --- HACKING.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/HACKING.md b/HACKING.md index 8309ea0e..890bb64e 100644 --- a/HACKING.md +++ b/HACKING.md @@ -57,6 +57,24 @@ $ gsettings set org.gnome.desktop.input-sources sources "[('xkb', 'us'), ('xkb', Coding ------ +### Project structure + +Rust modules should be split into 2 categories: libraries, and user interface. They differ in the way they do error handling. + +Libraries should: + +- not panic due to external surprises, only due to internal inconsistencies +- pass errors and surprises they can't handle to the callers instead +- not silence errors and surprises + +User interface modules should: + +- try to provide safe values whenever they encounter an error +- do the logging +- give libraries the ability to report errors and surprises (e.g. via giving them loggers) + +### Style + Code submitted should roughly match the style of surrounding code. Things that will *not* be accepted are ones that often lead to errors: - skipping brackets `{}` after every `if()`, `else`, and similar