From d783218b358167fb4ae32ae0f03772f04849d588 Mon Sep 17 00:00:00 2001 From: Gerd Aschemann Date: Wed, 2 Oct 2024 09:37:06 +0200 Subject: [PATCH] #343 Fix and update "adding new checks" list --- src/docs/development/development-intro.adoc | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/src/docs/development/development-intro.adoc b/src/docs/development/development-intro.adoc index 1ef353ce..7bf1f328 100644 --- a/src/docs/development/development-intro.adoc +++ b/src/docs/development/development-intro.adoc @@ -30,10 +30,12 @@ You should definitely read the original https://www.gradle.org/docs/current/user To add new checks, you have to subclass from 'org.aim42.htmlsanitycheck.check.Checker' and implement the 'performCheck' method - which requires an 'HtmlPage' instance as parameter. -Don't forget to: -* write a test or spec for your checker - the code in 'test/groovy/org.aim42.htmlsanitycheck.check' +Remember to: + +* Write a (JUnit) test or (Spock) spec for your checker - +the code in https://github.com/aim42/htmlSanityCheck/tree/develop/htmlSanityCheck-core/src/test/groovy/org/aim42/htmlsanitycheck/check[htmlSanityCheck-core/src/test/groovy/org/aim42/htmlsanitycheck/check] gives many examples -* add your checker class to the 'public static AllCheckers' list (Set, to be precise) +* Add your checker class to the https://github.com/aim42/htmlSanityCheck/blob/develop/htmlSanityCheck-core/src/main/java/org/aim42/htmlsanitycheck/check/AllCheckers.java[`public static AllCheckers`] list of available checkers. This set is used to configure the 'AllChecksRunner' class. === Directory Structure and Required Files