owncloud / owncloud/android

[TECHNICAL] More rules for Detekt

Open
#4,541 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Estimation - 5 (L) Technical
Dominant language
Kotlin
Stars
4.2k
Forks
3.1k
Avg merge
1d 12h
Merged PRs (30d)
7

Description

There were some rules that could not be addressed in the first issue of Detekt (https://github.com/owncloud/android/issues/4506) due to their big scope. These are:

  • CognitiveComplexMethod
  • NestedBlockDepth
  • LoopWithTooManyJumpStatements

In this issue, they will be enabled in the rule set and the related code smells will be fixed.

  • Research (if needed)
  • Create branch technical/detekt_2
  • Development tasks
    • Enable and fix CognitiveComplexMethod
    • Enable and fix NestedBlockDepth
    • Enable and fix LoopWithTooManyJumpStatements
  • Code review and apply changes requested
  • Design test plan
  • QA
  • Merge branch technical/detekt_2 into master

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Read issue 4506 for the earlier Detekt work, then research the three named rules: CognitiveComplexMethod, NestedBlockDepth, and LoopWithTooManyJumpStatements. Done means enabling each rule, fixing the related code smells, completing the development and test-plan tasks, and addressing review and QA feedback before merging technical/detekt_2 into master.

Written by the indexing model from the issue text.

Assessment

Tech stack
kotlin
Domain
mobile-dev, tooling
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.