vercel/hyper

Document Hyper architecture

Open

#817 geöffnet am 7. Okt. 2016

Auf GitHub ansehen
 (0 Kommentare) (11 Reaktionen) (0 zugewiesene Personen)TypeScript (44.582 Stars) (3.558 Forks)batch import
help wanted🎨 Type: Enhancement💛 Priority: Medium

Beschreibung

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

Tech Stack
typescriptelectronreact
Domain
documentationdesktop
Issue Type
documentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-2 days
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
stale
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
clear
Voraussetzungen
Basic knowledge of HyperFamiliarity with Electron appsUnderstanding of React and Redux
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70
Research-Richtung
Examine the Hyper source code to identify the key components: hterm (the terminal emulator), Electron main process, Redux store, and UI presentation layer. Look at the file structure to understand how they communicate. Then create block diagrams illustrating their relationships and data flow. Also review any existing documentation or comments in code to ensure accuracy.