diff options
| author | CalMWolfs <94038482+CalMWolfs@users.noreply.github.com> | 2024-09-27 13:23:45 +1000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-09-27 13:23:45 +1000 |
| commit | c4b7ec8846432946fdc8e648a98c0aebaf613c53 (patch) | |
| tree | 528ae02a88963e72c52e0fce71a4931e0c0b8be4 /CONTRIBUTING.md | |
| parent | 65dde77f6d604faf4a87ddbff2477ee7629bc07f (diff) | |
| download | skyhanni-c4b7ec8846432946fdc8e648a98c0aebaf613c53.tar.gz skyhanni-c4b7ec8846432946fdc8e648a98c0aebaf613c53.tar.bz2 skyhanni-c4b7ec8846432946fdc8e648a98c0aebaf613c53.zip | |
Backend: Explain double baseline.xml file (#2609)
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d68b88f9f..90fcd0250 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -101,7 +101,9 @@ format like "- #821" to illustrate the dependency. - `detekt` is our code quality tool. It checks for code smells and style issues. - If you have a build failure stating `Analysis failed with ... weighted issues.`, you can check `versions/[target version]/build/reports/detekt/` for a comprehensive list of issues. - **There are valid reasons to deviate from the norm** - - If you have such a case, either use `@Supress("rule_name")`, or re-build the `baseline.xml` file, using `./gradlew detektBaseline`. + - If you have such a case, either use `@Supress("rule_name")`, or re-build the `baseline.xml` file, using `./gradlew detektBaselineMain`. + After running detektBaselineMain, you should find a file called `baseline-main.xml` in the `version/1.8.9` folder, rename the file to + `baseline.xml` replacing the old one. You also should copy the new contents of this file to the [main baseline file](detekt/baseline.xml) - Do not copy features from other mods. Exceptions: - Mods that are paid to use. - Mods that have reached their end of life. (Rip SBA, Dulkir and Soopy). |