开发者文档与贡献
本节提供给想了解 Onlook 架构、为项目贡献代码或扩展功能的开发者技术文档。
概览
Onlook 采用 monorepo 结构，包含若干相互关联的应用和包，主要使用 Next.js、React、TypeScript 和 Vite 构建。
为 Onlook 贡献代码
我们欢迎为 Onlook 贡献代码！本指南将帮助你开始为项目贡献。
在向本仓库贡献代码之前，请先通过issues、Discord、电子邮件或其他方式，与本仓库拥有者讨论你想进行的更改。
请注意，我们有行为准则，请在所有项目互动中遵守。
本地运行项目
你可以按照这里的说明从源码构建项目。
提交拉取请求流程
- 要创建拉取请求（PR），请先 Fork 本项目。
- 在你 Fork 的仓库中进行更改，并从该 Fork 创建拉取请求。
-
更新拉取请求描述，说明更改内容。如相关，链接对应 issue。
-
勾选“允许维护者编辑”（Allow edits from maintainer）复选框。这样维护者可以在必要时更新你的 PR，加快审核流程。详情查看。
- 请求一位维护者审查。审核通过后，他们将合并你的 PR。
代码风格指南
我们尽量遵循 Clean Code 指南和童子军规则：
“让代码比你接手时更干净，而不是更乱”。
测试
我们使用 Bun 进行测试。
bun test代码规范检查
我们使用 ESLint 进行代码规范检查，使用 Prettier 进行格式化。此操作会在每次提交时执行。
bun lint
bun format类型安全
我们使用 TypeScript 保证类型安全。
要检查 web 客户端的类型，运行：
cd apps/web/client && bun run typecheck