mirror of
https://github.com/jlengrand/detekt.git
synced 2026-03-10 08:11:23 +00:00
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:
2
.github/CONTRIBUTING.md
vendored
2
.github/CONTRIBUTING.md
vendored
@@ -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)
|
||||
|
||||
Reference in New Issue
Block a user