telefonicaid / telefonicaid/iotagent-node-lib
Add missing JSDoc
Open
Nobody has claimed this yet.
documentation
techdebt
- Dominant language
- JavaScript
- Stars
- 62
- Forks
- 90
- Avg merge
- 2h 35m
- Merged PRs (30d)
- 1
Description
Some of the module functions lack of a good JSDoc documentations. This should be addressed, at least for the most important or complicated functions.
Contributor guide
No contributing guide indexed for this repository
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 reviewing the module functions to identify the important or complicated ones that lack adequate JSDoc. Done means those selected functions have clear, useful JSDoc documentation; the issue does not name specific files or tests to run.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100