nodejs / nodejs/package-maintenance
[MQTT.js] issues analysis - words tool
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 423
- Forks
- 147
- PR merge metrics
- No merged PRs in 30d
Description
Based on this documents this issue cover a bullet point from this task list
The topic is:
improve documentation
-create a word-cloud of the issues' text to understand the most frequent problem
- create good-first-issue for those missing docs
For this issue, I think we could:
- build a tool that creates a word cloud in order to visualize the most commons problems
- validate the results of this idea (the word cloud is enough to create an issue with title
write better docs about xyz)
I think that we must consider that our actions should be replicable for other packages, also.
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 with pilots/mqttjs/TASKS.md and the linked pilots documents to understand the documentation goal. Define how the proposed issue-text word-cloud tool should be run and what validation is expected. Done means the approach is replicable for other packages and supports identifying concrete missing-documentation issues.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- node.js
- Domain
- documentation, tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100