贡献 Chakra UI

感谢您对贡献 Chakra UI 💖 的兴趣，您真棒！

概览

以下是您可以帮助改进 Chakra UI 的几种方式

• 改进文档：添加新的演示、修复错别字或添加缺失的信息。
• 添加新的演示：将新的组件演示添加到网站和 Storybook。打开一个 PR 到apps/compositions/src/examples
• 修复错误：报告错误、修复错误或添加缺失的功能。
• 贡献代码：通过发起 Github 讨论提出新功能，或寻找现有错误进行修复。
• 改进代码：改进代码、修复错误或添加缺失的功能。

架构

Chakra v3.x 是 Chakra 生态系统中两个项目 Ark UI 和 Zag.js 的组合。目标是在 Chakra UI 中尽可能少地维护代码，并将繁重的工作委托给这些项目。

提交问题

在 Chakra v3.x 上提交问题的思路如下

• 如果问题是逻辑或可访问性错误，那么它很可能是 Zag.js 中的错误。考虑在 Zag.js 仓库中打开一个问题。

• 如果是样式问题，那么您可以直接在 Chakra UI 仓库中修复它。

功能请求

在 Chakra v3.x 上提交功能请求的思路如下

• 如果该功能是一个没有逻辑的新组件，那么它可以放在 Chakra UI 或 Ark UI 中。在 Chakra UI 仓库中发起讨论。

• 如果该功能是一个带有逻辑的新组件，它属于 Zag.js。在 Zag.js 仓库中发起讨论。

本地设置

• 克隆仓库

git clone https://github.com/chakra-ui/chakra-ui.git

• 使用 pnpm 安装依赖

pnpm install

• 构建所有包的本地版本

pnpm build:fast

• 启动 Storybook

pnpm storybook

• 启动文档网站

pnpm www dev

• 运行测试

pnpm test

推荐扩展

我们建议在您的编辑器中使用以下扩展

• ESLint
• Prettier
• EditorConfig
• MDX