facundoolano/advenjure

auto generated API reference

Open

#22 opened on Oct 16, 2017

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Clojure (18 forks)github user discovery
help wanted

Repository metrics

Stars
 (318 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

which would require to polish docstrings everywhere

Contributor guide

Research direction
Review existing docstrings in the project, identify missing or incomplete ones, and ensure consistency. Then explore tools like codox or cljdoc for automatic API reference generation and configure them.
Tech stack
clojure
Domain
documentation
Issue type
Feature
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-2 days
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.
Needs investigation
Prerequisites
ClojureDocumentation tools
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65