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.