vercel/hyper

Document Hyper architecture

Open

#817 建立於 2016年10月7日

在 GitHub 查看
 (0 留言) (11 反應) (0 負責人)TypeScript (44,582 star) (3,558 fork)batch import
help wanted🎨 Type: Enhancement💛 Priority: Medium

描述

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.

貢獻者指南

技術棧
typescriptelectronreact
領域
documentationdesktop
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-2 days
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
Basic knowledge of HyperFamiliarity with Electron appsUnderstanding of React and Redux
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
70
研究方向
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.