Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Improvement] Refactoring Code For Better Comprehension #15599

Closed
2 of 3 tasks
EricGao888 opened this issue Feb 20, 2024 · 7 comments
Closed
2 of 3 tasks

[Improvement] Refactoring Code For Better Comprehension #15599

EricGao888 opened this issue Feb 20, 2024 · 7 comments
Labels
help wanted Extra attention is needed improvement make more easy to user or prompt friendly Stale

Comments

@EricGao888
Copy link
Member

Search before asking

  • I had searched in the issues and found no similar feature requirement.

Description

Currently some parts of code are poorly constructed, leading to difficult comprehension, trouble of testing and maintenance.

With an IntelliJ plugin, metrics reloaded, we could get the complexity of methods in this project.

image

If the cognitive complexity of a method is more than 30, basically we treat it as incomprehensible, untestable and unmaintainable. We would like to have these methods refactored and achieve a significant decrease in complexity, maybe 50% or more.

Any help will be appreciated : )

https://plugins.jetbrains.com/plugin/93-metricsreloaded

https://www.hatica.io/blog/code-complexity/

Are you willing to submit a PR?

  • Yes I am willing to submit a PR!

Code of Conduct

@EricGao888 EricGao888 added help wanted Extra attention is needed improvement make more easy to user or prompt friendly labels Feb 20, 2024
@stonelion
Copy link

Is it only for a specific package, or all of them?

@pinkfloyds
Copy link
Contributor

I can't agree more with your advice ,really need refactoring code.

@EricGao888
Copy link
Member Author

Is it only for a specific package, or all of them?

We could do it iteratively, with priority.

@akshitk20
Copy link

@EricGao888 seems like i do not have write access to this repo. Due to this I am unable to push my feature branch for this issue. Could you help here

@EricGao888
Copy link
Member Author

@EricGao888 seems like i do not have write access to this repo. Due to this I am unable to push my feature branch for this issue. Could you help here

Hi @akshitk20 , you don't need direct write access to this repo to contribute. You could submit a PR and maintainers will review it and then help merge it.

FYI:
https://github.com/sevntu-checkstyle/sevntu.checkstyle/wiki/Development-workflow-with-Git:-Fork,-Branching,-Commits,-and-Pull-Request

Copy link

This issue has been automatically marked as stale because it has not had recent activity for 30 days. It will be closed in next 7 days if no further activity occurs.

@github-actions github-actions bot added the Stale label Apr 11, 2024
Copy link

This issue has been closed because it has not received response for too long time. You could reopen it if you encountered similar problems in the future.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed improvement make more easy to user or prompt friendly Stale
Projects
None yet
Development

No branches or pull requests

4 participants