Skip to content

Commit

Permalink
simplify README.md
Browse files Browse the repository at this point in the history
Signed-off-by: Nikolay <primechord@ya.ru>
  • Loading branch information
primechord authored May 1, 2024
1 parent 90e9772 commit 1323483
Showing 1 changed file with 8 additions and 20 deletions.
28 changes: 8 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,26 @@
# Detekt rules for UI-tests

A set of [Detekt](https://detekt.dev) rules to help prevent common errors in UI-tests.
A set of [Detekt](https://detekt.dev) rules to help prevent common errors in UI-tests.
[[RU] Detekt: How static analysis helps to improve autotest code](https://habr.com/p/779152)

# Rules description

[[RU] Detekt: How static analysis helps to improve autotest code](https://habr.com/p/779152)

TestClassNamingRule:
* TestClassNamingRule:
A test class name should fit the naming convention;

TestMethodNamingRule:
* TestMethodNamingRule:
Test method name should not be long and contain unnecessary words;

TestClassPrivateMemberRule:
* TestClassPrivateMemberRule:
Members of test class must use private modifier;

IsVisibleUsageRule:
* IsVisibleUsageRule:
In general, 'Kaspresso isVisible' should not be used -> use 'isDisplayed';

LargeScreenObjectRule:
* LargeScreenObjectRule:
Split a large ScreenObject into PageElement's and combine them on this SO;

RestrictedKeywordRule:
* RestrictedKeywordRule:
Restricted keyword for test method, ScreenObject and Scenario.

# Installation and configuration
Expand Down Expand Up @@ -63,14 +62,3 @@ ui-tests:

# Contributors
[primechord](https://github.com/primechord/)

# License
```
Copyright 2023 Yandex LLC
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
```

0 comments on commit 1323483

Please sign in to comment.