vmware / vmware/singleton

Add appropriate comments to Javascript Client methods

Open
#168 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

area/js-client
Dominant language
Java
Stars
72
Forks
69
Avg merge
23h 32m
Merged PRs (30d)
4

Description

There are a lot of methods in the js client that don’t have appropriate comments

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the JavaScript client and inventorying methods without appropriate comments. Review existing comments to determine the project’s conventions and scope; done means the client methods identified as lacking comments have clear, consistent documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.