Skip to content

Commit

Permalink
Documentation | Added Static Code Analysis & Linting Sub-Section (#7)
Browse files Browse the repository at this point in the history
  • Loading branch information
TomPlum committed Nov 9, 2020
1 parent 94fc709 commit 222915f
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ runtime complexity will be refactored and improved upon in a later pass of the d
* [The Codebase](#the-codebase)
* [Package Structure](#package-structure)
* [Design](#design)
* [Static Code Analysis & Linting](#static-code-analysis--linting)
* [Testing](#testing)
* [Java Micro-Benchmarking Harness](#jmh-java-micro-benchmarking-harness)
* [JUnit5 & AssertK](#junit5--assertk)
Expand Down Expand Up @@ -78,6 +79,10 @@ behaviour that is commonly used across multiple days and `test-support` for unit
### Design
-Design Patterns

### Static Code Analysis & Linting
I used the [DeteKT](https://detekt.github.io/detekt/index.html) Gradle plugin to perform static code analysis on the
codebase. It produces a report containing all the code-smells that it found based on the set configuration.

### Testing

#### JMH (Java Micro-Benchmarking Harness)
Expand Down

0 comments on commit 222915f

Please sign in to comment.