参与 Oxc 贡献
感谢您对参与 Oxc 贡献的兴趣!我们正在构建下一代 JavaScript 工具链,非常欢迎您的帮助。
快速入门
最快上手的方式是通过我们的 良好的首个问题。这些任务经过精心挑选,非常适合新贡献者。
需要指导?加入我们的 Discord 社区,我们的团队和社区成员都很乐意提供帮助。
贡献方式
我们欢迎并珍视任何形式的贡献:
🐛 错误报告
- 报告解析错误或不正确的代码检查行为
- 分享性能问题或回归问题
- 记录我们尚未考虑的边缘情况
🚀 功能开发
- 添加新的代码检查规则
- 提升解析器的兼容性
- 增强转换器功能
- 在 Oxc 生态系统中构建新工具
📚 文档
- 改进入门指南
- 添加示例和教程
- 记录架构决策
- 将内容翻译成其他语言
🧪 测试
- 从真实项目中添加测试用例
- 提高测试覆盖率
- 创建性能基准测试
- 对生态系统项目进行测试
🔧 基础设施
- 改进构建和 CI 系统
- 增强开发工具链
- 优化性能关键路径
- 保持与其他工具的兼容性
理解代码库
Oxc 按照多个模块(crates)组织:
oxc_parser:高性能的 JavaScript/TypeScript 解析器oxc_linter:拥有 650 多条规则的快速代码检查引擎oxc_transformer:TypeScript 与 JSX 转换oxc_minifier:JavaScript 压缩工具(开发中)oxc_formatter:代码格式化工具,兼容 Prettier(Alpha 版)
您的首次贡献
- 浏览问题:查找标记为
good first issue的问题 - 提出疑问:不要犹豫,在 Discord 或 GitHub 上寻求澄清
- 从小处着手:从文档改进或小错误修复开始
- 学习模式:研究现有代码以理解我们的规范
社区
沟通渠道
- GitHub Discussions:用于设计讨论和提问
- Discord:与团队和社区实时交流
- GitHub Issues:错误报告和功能请求
- Twitter:关注 @boshen_c 以获取最新动态
行为准则
我们致力于为所有人提供友好、包容的体验。请在参与前阅读我们的 行为准则。
AI 使用政策
当使用 AI 工具(包括 LLM 如 ChatGPT、Claude、Copilot 等)为 Oxc 贡献时:
- 请披露使用 AI 以减少维护者负担
- 您需对提交的所有由 AI 生成的问题或拉取请求负责
- 低质量或未经审查的 AI 内容将被立即关闭
我们鼓励使用 AI 工具辅助开发,但所有贡献在提交前必须经过贡献者的彻底审查和测试。由 AI 生成的代码应被充分理解、验证,并适配符合 Oxc 标准的要求。
下一步
准备好了吗?以下是几个不错的起点:
- 📖 了解更多:查看我们的 开发指南
- 🔍 寻找一个问题:浏览我们的 良好的首个问题
- 💬 加入社区:通过 Discord 与我们连接
- 🛠️ 选择一个工具:深入 解析器、代码检查器、转换器 或 其他工具
- ⚡️ 发起拉取请求:阅读我们的 拉取请求规则与政策 开始行动。
我们迫不及待想看到您与我们一起创造的内容!🚀
