贡献指南

欢迎加入Toolala工具站开发者社区！

感谢您有兴趣为Toolala工具站做出贡献！无论是报告bug、建议新功能，还是提交代码改进，您的贡献都对我们非常重要。

成为贡献者

开始贡献

1

设置开发环境

首先，您需要将项目克隆到本地：

git clone https://github.com/coke-tools/coke-tools.git

安装依赖：

npm install
2

选择或创建Issue

查看我们的GitHub Issues，选择一个您想解决的问题或创建一个新Issue描述您想贡献的内容。

对于较大的改动，建议先讨论您的想法再开始编码。

3

创建特性分支

从最新的main分支创建一个新的特性分支：

git checkout -b feature/your-feature-name
4

提交您的更改

在提交代码时，请遵循我们的提交信息规范：

git commit -m "feat: 添加新工具"

提交信息前缀可以是：feat(新功能), fix(错误修复), docs(文档), style(样式), refactor(重构), test(测试), chore(构建/工具)

5

推送并创建Pull Request

将您的分支推送到GitHub：

git push origin feature/your-feature-name

然后在GitHub上创建一个Pull Request，描述您的更改并关联相关Issue。

代码规范

代码风格

  • 使用2个空格缩进
  • 遵循ESLint规则
  • 组件和工具函数必须有JSDoc注释
  • 保持代码简洁和可读性

文档要求

  • 新功能必须附带使用文档
  • 更新CHANGELOG.md文件
  • 代码注释使用英文书写

测试要求

  • 新功能必须包含单元测试
  • 确保所有测试通过
  • 测试覆盖率不应低于80%

贡献类型

报告Bug

在GitHub Issues中报告您发现的bug，请包含重现步骤和环境信息。

建议功能

提出新工具或改进建议，描述使用场景和预期行为。

代码贡献

直接贡献代码修复bug或实现新功能。

文档改进

改进文档、翻译或添加使用示例。

贡献者许可协议(CLA)

在合并您的第一个Pull Request之前，您需要签署我们的贡献者许可协议。这确保您的贡献可以安全地包含在项目中。

加入社区

有问题或想与其他贡献者交流？加入我们的开发者社区：

GitHub QQ群