fbchat-dev/fbchat

Documentation

Open

#222 opened on Oct 21, 2017

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Python (406 forks)github user discovery
enhancementhelp wanted

Repository metrics

Stars
 (1,210 stars)
PR merge metrics
 (PR metrics pending)

Description

The documentation on ReadTheDocs is still lacking quite a bit, mostly in easy explainations for beginners, though a few functions also still remain undocumented. A partial TODO can be found here. Any help would be appreciated!

Contributor guide

Research direction
Read the existing documentation and the TODO list. Choose an undocumented function, trace its usage in the codebase, and write documentation following the existing style.
Tech stack
python
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.
Half day
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
GitPython
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75