From 758a81e3dbf48225761fb505bce9be9f51371b83 Mon Sep 17 00:00:00 2001 From: Evgenii Alekseev Date: Sat, 31 Aug 2024 15:33:32 +0300 Subject: [PATCH] chore: small contributing guide update --- CONTRIBUTING.md | 2 +- README.md | 2 ++ 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 662cfa93..a3999ee0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -132,7 +132,7 @@ Again, the most checks can be performed by `tox` command, though some additional * For any path interactions `pathlib.Path` must be used. * Configuration interactions must go through `ahriman.core.configuration.Configuration` class instance. * In case if class load requires some actions, it is recommended to create class method which can be used for class instantiating. -* The code must follow the exception safety, unless it is explicitly asked by end user. It means that most exceptions must be handled and printed to log, no other actions must be done (e.g. raising another exception). +* The most (expected) exceptions must be handled and printed to log, allowing service to continue work. However, fatal and (in some cases) unexpected exceptions may lead to the application termination. * Exceptions without parameters should be raised without parentheses, e.g.: ```python diff --git a/README.md b/README.md index fa7a267e..c3f1f2b1 100644 --- a/README.md +++ b/README.md @@ -40,3 +40,5 @@ The application provides reasonable defaults which allow to use it out-of-box; h * [Build status page](https://ahriman-demo.arcanis.me). You can log in as `demo` user by using `demo` password. However, you will not be able to run tasks. [HTTP API documentation](https://ahriman-demo.arcanis.me/api-docs) is also available. * [Repository index](https://repo.arcanis.me/arcanisrepo/x86_64/). * [Telegram feed](https://t.me/arcanisrepo). + +Do you have any success story? You can [share it](https://github.com/arcan1s/ahriman/issues/new?template=04-discussion.md)!