From 222915fc5b012843aa5a882678078747ceb297fb Mon Sep 17 00:00:00 2001 From: TomPlum Date: Mon, 9 Nov 2020 21:37:45 +0000 Subject: [PATCH] Documentation | Added Static Code Analysis & Linting Sub-Section (#7) --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index 82a2316..e33edeb 100644 --- a/README.md +++ b/README.md @@ -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) @@ -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)