Skip to content

Commit

Permalink
add simple description in README
Browse files Browse the repository at this point in the history
  • Loading branch information
volodya-lombrozo committed Nov 9, 2022
1 parent 30c1952 commit 0882412
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,19 @@
# test-naming-conventions

Almost each project uses unit tests in codebase. It is important to have
a common pattern of naming all that tests, because otherwise the project and
tests itself become a complete mess. It's a quite large discussion about
different [test naming patterns](https://stackoverflow.com/questions/155436/unit-test-naming-best-practices).
**test-naming-conventions** maven plugin helps to keep follow a single
common test naming rule across all of your test classes.
## How to use
In order to use the plugin with the latest version just invoke the next
command in the root of your project:
```shell
mvn com.github.volodya-lombrozo:test-naming-conventions:check
```
If you want to use specific version, for example `0.1.0`, just run the next
command
```shell
mvn com.github.volodya-lombrozo:test-naming-conventions:0.1.0:check
```

0 comments on commit 0882412

Please sign in to comment.