eclipse-cdt-cloud / eclipse-cdt-cloud/theia-trace-extension
Improve view names and descriptions
- Dominant language
- TypeScript
- Stars
- 50
- Forks
- 60
- PR merge metrics
- No merged PRs in 30d
Description
Many view names and descriptions could be clarified/improved.
Examples of possible confusion:
* Histogram (A histogram of what? Can I choose what data to use?)
* Flame Chart (A flame chart of what?)
* Disk I/O View --> Disk I/O?
* IRQ Analysis (What is being analyzed? Or for noobs, what does IRQ mean?)
## Name guidelines
Names should explain what data is shown (and ideally also suggest how it should be analyzed or why it is useful). The graph type isn't necessarily useful information
* Example: "Events over time" (Distribution of trace events in time) instead of "Histogram"
⚠️Changes to naming need to be made with extreme caution because they can be highly disruptive to established users (they need to reprogram their reflexes). @bhufmann @mirsky-work @MatthewKhouzam Do you know how open users are to naming changes?
Related: #275
Contributor guide
Research direction
No files or tests are named. Start by locating the TypeScript UI definitions for the Histogram, Flame Chart, Disk I/O View, and IRQ Analysis labels and descriptions, then review related issue #275. Done means proposed names explain the displayed data consistently while accounting for the compatibility concerns and caution around established users.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- data-visualization, frontend
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100