参与贡献 Oxc

感谢你有兴趣参与 Oxc！我们正在打造下一代 JavaScript 工具链，非常欢迎你的帮助。

快速开始

最简单的起步方式是查看我们的 good first issues。这些是专门挑选出来、适合新贡献者的任务。

需要指路？欢迎加入我们的 Discord 社区，团队与社区伙伴都很乐意协助。

贡献方式

我们欢迎任何形式的参与：

🐛 缺陷报告

• 报告解析错误或不正确的 Lint 行为
• 反馈性能问题或性能回退
• 记录我们尚未考虑的边界情况

🚀 功能开发

• 新增 Lint 规则
• 提升解析器一致性
• 增强 Transformer 能力
• 在 Oxc 生态中构建新工具

📚 文档

• 改进入门文档
• 补充示例与教程
• 记录架构层面的决策
• 将内容翻译成其他语言

🧪 测试

• 从真实代码库补充测试用例
• 提高测试覆盖率
• 编写性能基准
• 在生态项目中做验证

🔧 基础设施

• 改进构建与 CI
• 完善开发辅助工具
• 优化性能关键路径
• 维护与其他工具的兼容性

了解代码结构

Oxc 由多个 crate 组成：

• oxc_parser：高性能 JavaScript/TypeScript 解析器
• oxc_linter：带 650+ 规则的快速 Lint 引擎
• oxc_transformer：TypeScript 与 JSX 转换
• oxc_minifier：JavaScript 压缩（开发中）
• oxc_formatter：代码格式化，与 Prettier 兼容

第一次贡献建议

1. 浏览 Issues：查找标有 good first issue 的条目
2. 大胆提问：在 Discord 或 GitHub 上说明疑惑
3. 从小做起：可先改文档或小修 Bug
4. 学习既定风格：阅读现有代码以对齐约定

社区

沟通渠道

• GitHub Discussions：设计与一般问题讨论
• Discord：与团队和社区实时聊天
• GitHub Issues：Bug 报告与需求
• Twitter：关注 @boshen_c 获取动态

行为准则

我们致力于为每个人提供友好、包容的交流环境。参与前请先阅读我们的 行为准则。

使用 AI 的规范

在使用 AI 工具（ChatGPT、Claude、Copilot 等 LLM）参与贡献时：

• 请主动披露 AI 使用情况，以减轻维护者负担
• 你对提交的 Issue/PR 负全责，包括其中由 AI 生成的内容
• 低质量或未认真审核的 AI 内容会被直接关闭
• 若反复提交低质量（「垃圾 PR」），可能在不事先警告的情况下被封禁。若你愿意遵守本政策继续参与，可申请解封——请通过我们的 Discord 联系。

我们鼓励用 AI 辅助开发，但所有提交前都应由你自己充分审阅与测试；AI 代码需能理解、校验并调整到符合 Oxc 标准。

下一步

准备好参与贡献？可以从这些地方开始：

• 📖 更多说明：参阅 开发指南
• 🔍 认领任务：浏览 good first issues
• 💬 加入社区：在 Discord 交流
• 🛠️ 选一个方向：深入了解 解析器、Linter、Transformer 或其他 Formatter 等相关工具
• ⚡️ 提交 PR：请先阅读 PR 规则与政策

我们期待与你共建！ 🚀