Skip to content

为Oxc做出贡献

🌐 Contributing to Oxc

感谢你有兴趣为 Oxc 做出贡献!我们正在构建下一代 JavaScript 工具,我们希望得到你的帮助。

🌐 Thank you for your interest in contributing to Oxc! We're building the next generation of JavaScript tooling, and we'd love your help.

快速开始

🌐 Quick Start

最快的入门方式是通过我们的好入门问题。这些是精心挑选的任务,非常适合新贡献者。

🌐 The fastest way to get started is through our good first issues. These are carefully selected tasks that are perfect for new contributors.

需要指导吗?加入我们的 Discord 社区,我们的团队和社区成员很乐意提供帮助。

🌐 Need guidance? Join our Discord community where our team and community members are happy to help.

贡献方式

🌐 Ways to Contribute

我们欢迎并感谢任何形式的贡献:

🌐 We welcome and appreciate any form of contributions:

🐛 错误报告

🌐 🐛 Bug Reports

  • 报告解析错误或不正确的代码检查行为
  • 分享性能问题或回归
  • 记录我们尚未考虑的文档边缘情况

🚀 功能开发

🌐 🚀 Feature Development

  • 添加新的代码检查规则
  • 提高解析器的一致性
  • 增强转换器功能
  • 在 Oxc 生态系统中构建新工具

📚 文档

🌐 📚 Documentation

  • 改进入门指南
  • 添加示例和教程
  • 记录架构决策
  • 将内容翻译成其他语言

🧪 测试

🌐 🧪 Testing

  • 从真实代码库中添加测试用例
  • 提高测试覆盖率
  • 创建性能基准
  • 针对生态系统项目进行测试

🔧 基础设施

🌐 🔧 Infrastructure

  • 改进构建和持续集成系统
  • 增强开发工具
  • 优化性能关键路径
  • 保持与其他工具的兼容性

理解代码库

🌐 Understanding the Codebase

Oxc 被组织成几个 crate(软件包):

🌐 Oxc is organized into several crates:

  • oxc_parser:高性能的 JavaScript/TypeScript 解析器
  • oxc_linter:拥有 650 多条规则的快速代码检查引擎
  • oxc_transformer:TypeScript 和 JSX 转换
  • oxc_minifier:JavaScript 压缩(开发中)
  • oxc_formatter:代码格式化,兼容 Prettier(处于 alpha 版本)

你的第一次贡献

🌐 Your First Contribution

  1. 浏览期刊:寻找标注为['good first issue'](https://github.com/oxc-project/oxc/labels/good first issue)的期刊
  2. 提问:不要犹豫,在 Discord 或 GitHub 上寻求澄清
  3. 从小做起:从文档改进或小型错误修复开始
  4. 学习模式:研究现有代码以理解我们的规范

社区

🌐 Community

沟通渠道

🌐 Communication Channels

  • GitHub 讨论:用于设计讨论和问题
  • Discord:与团队和社区的实时聊天
  • GitHub 问题:错误报告和功能请求
  • 推特:关注 @boshen_c 获取更新

行为准则

🌐 Code of Conduct

我们致力于为每个人提供一个欢迎和包容的体验。请在参与之前阅读我们的行为准则

🌐 We are committed to providing a welcoming and inclusive experience for everyone. Please read our Code of Conduct before participating.

人工智能使用政策

🌐 AI Usage Policy

在使用人工智能工具(包括像 ChatGPT、Claude、Copilot 等大型语言模型)为 Oxc 做出贡献时:

🌐 When using AI tools (including LLMs like ChatGPT, Claude, Copilot, etc.) to contribute to Oxc:

  • 请披露 AI 使用情况 以减少维护者疲劳
  • 你需要对你提交的所有 AI 生成的问题或拉取请求负责
  • 低质量或未经审核的 AI 内容将被立即关闭

我们鼓励使用人工智能工具来辅助开发,但所有贡献在提交之前必须由贡献者自行彻底审查和测试。AI生成的代码应被理解、验证,并根据Oxc的标准进行调整。

🌐 We encourage the use of AI tools to assist with development, but all contributions must be thoroughly reviewed and tested by the contributor before submission. AI-generated code should be understood, validated, and adapted to meet Oxc's standards.

下一步

🌐 Next Steps

准备好贡献了吗?这里有一些不错的起点:

🌐 Ready to contribute? Here are some great places to start:

我们迫不及待想看你会和我们一起创造什么!🚀

🌐 We can't wait to see what you'll build with us! 🚀