luckyframework/avram

Add inline documentation

Open

#35 opened on Dec 4, 2017

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Crystal (67 forks)auto 404
good first issue

Repository metrics

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

Description

Inline documentation was purposely left off when things were changing, but now the API is starting to stabilize. Adding documentation to the public facing methods would be fantastic.

If you'd like to help, here is how Crystal docs work: https://crystal-lang.org/docs/conventions/documenting_code.html

Feel free to make small PRs so it's easy to review and merge them in :D

Thanks so much for the help!

Contributor guide

Research direction
Read the Crystal documentation conventions linked in the issue, then pick a public method and add inline documentation following those conventions.
Tech stack
None
Domain
backend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
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
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85