From b72898bff32f59f9af559fea617b5010bd2f22c2 Mon Sep 17 00:00:00 2001 From: marschwar Date: Tue, 6 Apr 2021 20:31:22 +0200 Subject: [PATCH] Add generateDocumentation task to contribution guide (#3552) Co-authored-by: Markus Schwarz --- .github/CONTRIBUTING.md | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 331270df6..54d3362b1 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -51,12 +51,11 @@ automatically. The format of the KDoc should be as follows: active: false name: whatever should be the default ``` - -- ... do not forget to test the new rule and/or add tests for any changes made to a rule. -Run detekt on itself and other kotlin projects with the `--run-rule RuleSet:RuleId` option to test your rule in isolation. -Make use of the `scripts/get_analysis_projects.groovy` script to automatically establish a set of analysis projects. -- ... do not forget to run `./gradlew build`. This will execute tests locally and update the `default-detekt.config.yml` -as well as add the new/changed rules to the documentation. +- ... run `./gradlew generateDocumentation` to add your rule and its config options to the `default-detekt-config.yml`. +- ... do not forget to run `./gradlew build`. This will execute tests locally. +- ... do not forget to test the new rule and/or add tests for any changes made to a rule. Run detekt on itself and other + kotlin projects with the `--run-rule RuleSet:RuleId` option to test your rule in isolation. Make use of + the `scripts/get_analysis_projects.groovy` script to automatically establish a set of analysis projects. - To print the AST of sources you can pass the `--print-ast` flag to the CLI which will print each Kotlin files AST. This can be helpful when implementing and debugging rules. - To view the AST (PSI) of your source code you can use the [PSI Viewer plugin](https://plugins.jetbrains.com/plugin/227-psiviewer) for IntelliJ.