documentation
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 5.8k
- Forks
- 704
- PR merge metrics
- No merged PRs in 30d
Description
I m currently using https://libgit2.github.com/libgit2/ as a documention, because a lot of methods are not documented yet in http://www.nodegit.org/api/.
Maybe add https://libgit2.github.com/libgit2/ as a reference somewhere or add the method and parameters descriptions to the documentation as most of them have not any. (e.g. on http://www.nodegit.org/api/index/#getByPath)
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 comparing the NodeGit API documentation, especially the getByPath entry, with the libgit2 reference linked in the issue. Determine whether the documentation should add the reference link or describe missing methods and parameters. Done means the chosen documentation scope is completed and the affected API entries are clearer.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, node.js
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100