peterbrittain/asciimatics

Developer documentation

Open

#38 opened on 2016年8月12日

GitHub で見る
 (2 comments) (1 reaction) (0 assignees)Python (3,479 stars) (244 forks)batch import
Documentationhelp wanted

説明

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.

コントリビューターガイド

技術スタック
python
領域
documentation
Issue 種別
documentation
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-2 days
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
stale
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
mostly clear
前提条件
Python knowledgeUnderstanding of asciimatics internals
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
60
調査方針
Explore the asciimatics codebase, focusing on the Windows/Curses screens implementation, the Effects and Scenes API, and the frame skipping logic. Review any existing documentation in the repository. Write a developer guide covering these topics, referencing source files like screens.py, effects.py, and scenes.py.