Skip to content

Commit 310e0e9

Browse files
authored
Add a section about severity level to the guidelines (#90) (#93)
1 parent 7d841b5 commit 310e0e9

File tree

1 file changed

+22
-1
lines changed

1 file changed

+22
-1
lines changed

README.adoc

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ Each error and notification comprises the following components, some of which ar
8787
| For example, `The database was unable to execute a remote part of the statement.`
8888

8989
| SeverityLevel
90-
|
90+
| See <<severity-level, Severity level>>.
9191
| One of `INFORMATION`\|`WARNING`
9292
m| ERROR
9393

@@ -174,6 +174,27 @@ See <<message, Message>>.
174174
| The label `Perso` does not exist.
175175
|===
176176

177+
[[severity-level]]
178+
==== Severity level
179+
180+
The severity can be one of the following:
181+
182+
* `WARNING`: It is about queries/commands that may have structural, syntactic, semantic, or spelling issues where the query most probably is wrong and/or should be updated.
183+
This includes deprecations, experimental features, trying to match entities with non-existing labels, etc.
184+
It should be clear what the problem is and it is also good to tell the possible cause, and the consequences, as well as give an example(s) and suggestion(s) for improvement.
185+
The most important part is that "we are (almost) certain it is a problem" and we know how to fix their query.
186+
For example:
187+
188+
** Deprecations – The users need to update the query with new functionality.
189+
** Experimental features – These cannot be trusted and should be updated if used in production.
190+
** Non-existing label – This query will never give any result, so it's either useless to run OR a misspelled label (unless they add a node with the label, but then the notification would disappear).
191+
192+
* `INFORMATION`: It is about queries/commands that are correct but may have some performance issues or that have no effect because they try to do something already done.
193+
Depending on the case, we may give an example(s) and suggestion(s) for improvement.
194+
195+
* `ERROR`: It is about queries/commands that fail to succeed.
196+
It's good to tell the user what triggers the error, an example, and a possible solution(s).
197+
177198
[[notification-description]]
178199
==== Notification description
179200

0 commit comments

Comments
 (0)