vercel/hyper

Document Hyper architecture

Open

#817 opened on Oct 7, 2016

View on GitHub
 (0 comments) (11 reactions) (0 assignees)TypeScript (3,558 forks)batch import
help wanted🎨 Type: Enhancement💛 Priority: Medium

Repository metrics

Stars
 (44,582 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

I think we should document the overall architecture to help new contributors get up to speed! I still don't have a grasp on the architecture. :worried: I'd be great to have some block diagrams and flow charts showing how the following are related and connected: hterm, electron, redux, ui presentation, etc.

Contributor guide

Research direction
Understand the Hyper architecture and create block diagrams and flowcharts showing how hterm, electron, redux, and UI presentation are related.
Tech stack
typescriptreact
Domain
desktop
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.
3-5 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
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85