philips-software / philips-software/cerberus
Usability issue - class/method names too long!
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 8
- Forks
- 6
- Avg merge
- 9h 22m
- Merged PRs (30d)
- 1
Description
Reported by one of the teams using JCMD-DIFF, the output generates a column called "CLASS", content of the class is more often than not, too long to read! This creates a distortion, where the necessary values (before/after/metrics) are pushed to the extreme right, and we are unable to easily view the output.
Since the filename is sufficient, i think skipping class would help in improving readability of the generated output!
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Locate the code that generates the JCMD-DIFF output and identify where the CLASS column is assembled. Check how omitting that column affects the filename and before/after/metrics values, then verify that the generated output is easier to read and that those necessary values remain visible.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100