mahmoud/glom

Incrementalize tutorial doc

Open

#11 opened on May 9, 2018

View on GitHub
 (9 comments) (6 reactions) (0 assignees)Python (77 forks)github user discovery
good first issuehelp wanted

Repository metrics

Stars
 (2,162 stars)
PR merge metrics
 (Avg merge 19m) (1 merged PR in 30d)

Description

Right now the tutorial is coherently designed, tested, and even documented. However, it doesn't build up in a way that's very beginner friendly. It establishes glom's value and then immediately uses it at an intermediate level.

I'd like it if it was a bit more drawn out to use basic features first and then add a multi-line Coalesce as the finisher. The announcement blog post does a better job of this, but doesn't go far enough before jumping ahead to T.

Contributor guide

Research direction
Study the current tutorial and the announcement blog post to identify the incremental structure. Outline the steps from basic to advanced features, then rewrite the tutorial accordingly.
Tech stack
python
Domain
documentation
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-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.
Clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80