vercel/hyper

Document Hyper architecture

Open

#817 ouverte le 7 oct. 2016

Voir sur GitHub
 (0 commentaires) (11 réactions) (0 assignés)TypeScript (44 582 stars) (3 558 forks)batch import
help wanted🎨 Type: Enhancement💛 Priority: Medium

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.

Guide contributeur

Stack technique
typescriptelectronreact
Domaine
documentationdesktop
Type d'issue
documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-2 days
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
stale
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
clear
Prérequis
Basic knowledge of HyperFamiliarity with Electron appsUnderstanding of React and Redux
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
70
Direction de recherche
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.