checkstyle / checkstyle/test-configs

Transfer common methods and nested classes to a separate utility class

Open
#257 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Java
Stars
3
Forks
11
Avg merge
3d 19h
Merged PRs (30d)
2

Description

Inspired from #254

We have some methods that potentially can or already are used repeatedly in multiple classes.

Some of common methods that are repeatedly used both in DiffTool.java and GitCommands.java from #254 :

https://github.com/checkstyle/test-configs/blob/22718ccf5b2fe08b6ab62ad0b0e790fc1f5e20b0/diff-java-tool/src/main/java/com/github/checkstyle/difftool/DiffTool.java#L1918-L1973

https://github.com/checkstyle/test-configs/blob/22718ccf5b2fe08b6ab62ad0b0e790fc1f5e20b0/diff-java-tool/src/main/java/com/github/checkstyle/difftool/DiffTool.java#L1139-L1182

https://github.com/checkstyle/test-configs/blob/22718ccf5b2fe08b6ab62ad0b0e790fc1f5e20b0/diff-java-tool/src/main/java/com/github/checkstyle/difftool/DiffTool.java#L2521-L2537

Contributor guide

Open the contributing guide

Research direction

Read the cited ranges in DiffTool.java and compare them with the corresponding common methods and nested classes in GitCommands.java. Identify the shared responsibilities and usages before choosing the separate utility class; the refactor is done when the shared members are centralized and both callers use them without duplicated definitions.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
tooling
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.