philips-software / philips-software/cerberus
Usability issue: Show link to JCMD MD file - to show descriptions of the terminologies used
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- Java
- Stars
- 8
- Forks
- 6
- Avg merge
- 9h 22m
- Merged PRs (30d)
- 1
Description
It's difficult to comprehend the meaning of all the metrics reported as part of JCMD. If we can have a hyperlink to the MD page calling out the description of each of the metrics, it'll be good as a quick reference.
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
Start by locating the JCMD output entry point and the Markdown page that describes its metrics. Check how the reported terminology is presented and determine where a reference link can be exposed. Done means users can follow a hyperlink from the JCMD output to the metric descriptions.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100