General housekeeping (#3298)

* General housekeeping

- Refactor more config keys as key companion object
- Convert some KDocs from using # into using []
- Remove self-recursive function in Context
- Fix correct dokka task name in CONTRIBUTING.md

* Revert change on Context.report

* Remove MAX_ISSUES_KEY back to IssueExtension

* Update detekt-core/src/main/kotlin/io/gitlab/arturbosch/detekt/core/config/IssueExtension.kt

Co-authored-by: Brais Gabín <braisgabin@gmail.com>

Co-authored-by: Brais Gabín <braisgabin@gmail.com>
This commit is contained in:
Chao Zhang
2020-12-24 09:25:42 -08:00
committed by GitHub
parent bb99e6951e
commit 0d6ac64b7d
10 changed files with 21 additions and 29 deletions

View File

@@ -1,7 +1,7 @@
# Contributing to detekt
- Read [this article](https://chris.beams.io/posts/git-commit/) before writing commit messages
- Use `gradle build -x dokka` to build the source but exclude documentation jar generating to save time.
- Use `gradle build -x dokkaJekyll` to build the source but exclude documentation jar generating to save time.
- `gradle detekt` should not report any errors
- This repository follows the [Kotlin Coding Conventions](https://kotlinlang.org/docs/reference/coding-conventions.html) which are enforced by ktlint when running `gradle detekt`.
- Make sure your IDE uses [ktlint](https://github.com/pinterest/ktlint) formatting rules as well as the settings in [.editorconfig](../.editorconfig)