贡献指南
感谢您对 uni-toolkit 的关注！我们欢迎任何形式的贡献，包括报告问题、提出建议、改进文档或提交代码。
开发流程
- Fork 本仓库
- 创建您的特性分支 (
git checkout -b feature/AmazingFeature) - 提交您的更改 (
git commit -m 'Add some AmazingFeature') - 推送到分支 (
git push origin feature/AmazingFeature) - 创建一个 Pull Request
添加新功能
添加新的拦截器
- 在
src/interceptors目录下创建新的拦截器文件 - 实现拦截器逻辑，确保支持多平台
- 在
src/interceptors/index.ts中导出您的拦截器 - 在
src/index.ts中添加导出 - 添加相应的测试用例
- 在 拦截器文档 中添加拦截器文档
添加新的 Hooks
- 在
src/hooks目录下创建新的 hook 文件 - 实现 hook 逻辑，确保类型安全
- 在
src/hooks/index.ts中导出您的 hook - 在
src/index.ts中添加导出 - 添加相应的测试用例
- 在 Hooks 文档 中添加 hook 文档
添加新的工具函数
- 在
src/tools目录下创建新的工具函数文件 - 实现工具函数逻辑，确保类型安全
- 在
src/tools/index.ts中导出您的工具函数 - 在
src/index.ts中添加导出 - 添加相应的测试用例
- 在 工具函数文档 中添加函数文档
添加新的环境检测功能
- 在
src/env目录下创建新的环境检测文件 - 实现环境检测逻辑，确保类型安全
- 在
src/env/index.ts中导出您的环境检测功能 - 在
src/index.ts中添加导出 - 添加相应的测试用例
- 在 环境检测文档 中添加功能文档
代码规范
- 使用 TypeScript 编写代码
- 遵循 ESLint 配置
- 添加适当的注释和文档
- 确保代码在所有目标平台上都能正常工作
提交规范
我们使用语义化提交消息，请遵循以下格式：
text
<type>(<scope>): <subject>
<body>Type 类型
feat: 新功能fix: 修复 bugdocs: 文档更新style: 代码格式（不影响代码运行的变动）refactor: 重构（既不是新增功能，也不是修改 bug 的代码变动）perf: 性能优化test: 增加测试chore: 构建过程或辅助工具的变动
Scope 范围
Scope 用于说明本次提交影响的范围，如：interceptors, hooks, tools, env 等。
Subject 主题
Subject 是对本次提交的简短描述，不超过 50 个字符。
Body 正文
Body 是对本次提交的详细描述，可以分多行，每行不超过 72 个字符。
测试
在提交代码前，请确保：
- 所有测试用例通过
- 新功能添加了相应的测试用例
- 代码覆盖率没有下降
文档
在添加新功能时，请确保：
- 更新相应的文档
- 添加必要的注释
- 提供清晰的使用示例
问题反馈
如果您发现问题或有改进建议，请：
- 检查是否已有类似的问题
- 创建新问题时，提供详细的问题描述和复现步骤
- 如果可能，提供相应的代码示例
许可证
通过贡献代码，您同意您的贡献将在 MIT 许可证 下发布。