简体中文 | English

贡献指南

感谢您对本项目的兴趣！为了帮助您顺利贡献代码或文档，我们制定了以下贡献指南。请在提交代码或问题前，仔细阅读以下内容。

如何贡献

1. 提交 Issue

如果您发现了 Bug、需要新功能或有改进建议，请通过 Issues 提交。请尽量提供详细信息，包括：

问题描述
重现步骤
预期结果和实际结果
系统和环境信息

2. 分支和 Pull Request 工作流程

步骤：

Fork 仓库：点击页面右上角的 "Fork" 按钮，将本仓库复制到您的 GitHub 账号中。
创建分支：在您的 Fork 仓库中创建一个新分支，分支命名应清晰简洁，例如 fix-bug-123 或 feature-new-function。
编写代码：在该分支上开发、修复 Bug 或添加功能。请确保您的代码风格与项目保持一致。
测试代码：确保您编写的代码已经通过了所有相关测试。如果可能，请为新功能添加测试。
提交代码：将您的修改提交到该分支，并推送到您的 Fork 仓库。
发起 Pull Request：在您的 Fork 仓库中，点击 "New Pull Request" 按钮，选择提交的分支并创建一个 Pull Request。请在描述中详细说明您的修改内容。

Pull Request 注意事项：

请确保代码清晰易读，尽量避免大规模提交多个修改。
每个 Pull Request 应专注于解决一个问题或添加一个功能。
在描述中明确解决的问题编号（如果适用）。
我们会审查您的 Pull Request 并提出反馈，请耐心等待。

3. 代码风格指南

为保持代码的一致性，请遵循以下代码风格规范：

确保代码易读、简洁。
命名应有意义，使用小写字母和下划线分隔（例如 my_function）。
每个函数/方法的长度应尽量简短，遵循单一职责原则。
遵守项目中的格式化工具（如 Prettier、ESLint 或其他工具）的规则。

4. 贡献文档

如果您发现文档中的错误或不清楚的地方，您可以直接修改并提交 Pull Request。文档的贡献与代码贡献流程类似。

感谢您的贡献

无论是提出问题、修复 Bug 还是贡献代码和文档，您的帮助都让这个项目变得更好！我们期待您的贡献！