From 364ba39fc17a16461df8bc0f8bbe60ec73008271 Mon Sep 17 00:00:00 2001 From: Paul Latzelsperger Date: Tue, 23 May 2023 09:19:00 +0200 Subject: [PATCH] docs: add decision record about activating checkstyle --- .../2023-05-23_activate_checkstyle/README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 docs/development/decision-records/2023-05-23_activate_checkstyle/README.md diff --git a/docs/development/decision-records/2023-05-23_activate_checkstyle/README.md b/docs/development/decision-records/2023-05-23_activate_checkstyle/README.md new file mode 100644 index 000000000..a42559758 --- /dev/null +++ b/docs/development/decision-records/2023-05-23_activate_checkstyle/README.md @@ -0,0 +1,17 @@ +# Activate Checkstyle to enforce code style + +## Decision + +From now on, Tractus-X EDC will use activate Checkstyle, i.e. change its reporting level from `WARNING` to `ERROR`. + +## Rationale + +We already have a checkstyle task in our Gradle setup, and our [PR Etiquette document](../../../../pr_etiquette.md) references +the styleguide and mandates its use. + +Our CI pipeline already uses checkstyle, but only outputs warning at the moment. + +## Approach + +- in `resources/tx-checkstyle-config.xml`, Line 22, change `` to ``. +- fix all checkstyle errors