CONTRIBUTING.md

贡献指南

感谢你对本项目感兴趣并希望贡献代码！为了确保贡献的顺利进行，请遵循以下流程和指南。

如何贡献

报告问题

1. 确保问题尚未被报告或解决。
2. 提供尽可能详细的信息，包括复现步骤、期望行为和实际行为。
3. 如果适用，附上相关截图或错误日志。

提交代码

1. Fork 本仓库
   在 GitHub 上点击 Fork 按钮，将此仓库复制到你的 GitHub 帐户中。

2. 创建特性分支
   在你的 fork 仓库中，创建一个新的分支用于开发。分支命名建议遵循以下格式：

   git checkout -b feature/描述你的功能
   git checkout -b fix/描述你的修复

3. 编写代码和测试

   • 编写清晰且符合项目风格的代码。
   • 尽量编写测试代码，以确保代码的正确性和稳定性。

4. 提交代码
   使用简洁且有描述性的提交信息提交代码。推荐的提交信息格式：

   [类型] 简要描述
   
   - 详细描述（可选）
   

   常见的类型包括：

   • feat: 新功能
   • fix: 修复问题
   • docs: 修改文档
   • style: 代码风格改进（不影响代码运行）
   • refactor: 代码重构
   • test: 添加或修改测试
   • chore: 其他非代码修改（构建工具、依赖更新等）

5. 同步主分支
   确保你的分支与上游仓库的 main（或 master）分支保持同步：

   git checkout main
   git pull upstream main
   git checkout feature/你的分支
   git rebase main

6. 提交 Pull Request

   • 在 GitHub 上提交 Pull Request，选择合适的标题并简要描述你的修改。
   • 如果你的代码修改解决了某个 issue，请在 Pull Request 中引用该 issue，例如：Closes #123。
   • 耐心等待维护者的反馈，并根据需要进行进一步修改。

代码风格

• 使用 ESLint 进行代码检查，遵循项目的 ESLint 规则。
• 确保所有 TypeScript 文件通过 TSLint 检查。

分支管理

• main（或 master）分支为生产分支，请勿直接在此分支提交代码。
• 所有新的功能或修复应在独立的分支上开发，并通过 Pull Request 合并到 main（或 master）分支。

开发环境

确保你的开发环境满足以下要求：

• Node.js 版本 >= 14.x
• Yarn 或 npm 最新版本
• TypeScript 版本 >= 4.x

联系我们

如果你有任何疑问或建议，请通过 GitHub Issues 或邮件联系我们。

感谢你的贡献！

使用说明

• 根据项目的实际情况调整 分支命名、提交信息格式 等部分。
• 如果有具体的代码风格指南或开发环境要求，可以详细说明。
• 请确保贡献者了解如何在本地测试他们的修改。