Skip to content

Commit 38fdbab

Browse files
Merge pull request #145 from datasharingframework/issue/144-update-severity-level-descriptions-in-linter-toolmd
Update linter documentation to clarify severity levels descriptions
2 parents 422839c + f6d4a69 commit 38fdbab

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

docs/src/process-development/linter-tool/linter-tool.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -758,10 +758,10 @@ All lint items extend `AbstractLintItem` and implement specific interfaces.
758758

759759
#### Severity Levels
760760

761-
- `ERROR`: Critical issues that must be fixed
762-
- `WARNING`: Issues that should be addressed
763-
- `INFO`: Informational messages
764-
- `SUCCESS`: Validation passed successfully
761+
- `ERROR`: Critical issue that **must be fixed**. Will cause the plugin to fail at deployment or runtime.
762+
- `WARNING`: Violation of DSF best practices, or something that **could be an error depending on context**.
763+
- `INFO`: Technically valid, but something looks unusual or incomplete. Worth a second look — no immediate action required.
764+
- `SUCCESS`: Validation passed. Shown to confirm what was checked and give confidence in the covered areas.
765765

766766
#### Common Lint Item Methods
767767

0 commit comments

Comments
 (0)