tarantool/tarantool-java

Improve API documentation

Open

#147 opened on Mar 29, 2019

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Java (20 forks)auto 404
documentationgood first issue

Repository metrics

Stars
 (52 stars)
PR merge metrics
 (PR metrics pending)

Description

Contributor guide

Research direction
Review the current API documentation at the provided link, identify classes and methods that are missing or incomplete, and add comprehensive javadoc comments or update the documentation generation files.
Tech stack
java
Domain
backendapi
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitJava
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85