peterbrittain/asciimatics

Developer documentation

Open

#38 opened on Aug 12, 2016

View on GitHub
 (2 comments) (1 reaction) (0 assignees)Python (244 forks)batch import
Documentationhelp wanted

Repository metrics

Stars
 (3,479 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

There are some aspects of the design that should be documented in a little more detail, but they don't naturally fall in the user guide. For example:

  1. Internals of Windows/Curses Screens
  2. Formal internal API for Effects and Scenes.
  3. Frame skipping for refresh (in order to reduce CPU)

This should be fleshed out into a proper developer guide.

Contributor guide

Research direction
Examine the asciimatics source code for Windows/Curses screen handling, Effects and Scenes API, and frame skipping logic. Document the internals in a developer guide.
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.
3
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
Python
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65