贡献指南

欢迎并感谢您对本项目的贡献！我们非常重视您的参与，并希望这份指南能帮助您顺利地为项目做出贡献。

如何贡献

报告问题

如果您在使用本项目时遇到任何问题，或者发现任何错误，请通过以下步骤报告问题：

1. 搜索现有问题 ：在提交新问题之前，请先搜索现有的问题列表，确保您的问题尚未被报告。
2. 创建新问题 ：如果问题尚未被报告，请点击“新建问题”按钮，并填写相关信息。请尽量详细地描述问题，包括复现步骤、预期行为和实际行为。

提交代码

如果您希望为项目贡献代码，请按照以下步骤操作：

1. Fork 项目 ：首先，请将本项目 fork 到您的 GitHub 账户中。
2. 创建分支 ：在您的 fork 项目中，创建一个新的分支用于您的更改。分支名称应简洁明了，反映出您所做的更改。
3. 进行更改 ：在您创建的分支中进行代码更改。请确保您的代码符合项目的编码规范。
4. 提交更改 ：完成更改后，提交您的更改，并撰写清晰的提交信息。
5. 创建 Pull Request ：将您的分支推送到 GitHub，并创建一个 Pull Request（PR）。在 PR 描述中，请详细说明您所做的更改及其目的。

代码审查

所有提交的代码都将经过代码审查。我们鼓励您在 PR 中进行自我审查，并回应审查者的反馈。代码审查的目的是确保代码质量，并帮助您改进代码。

编码规范

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

• 缩进 ：使用 4 个空格进行缩进。
• 命名 ：变量和函数名应使用小写字母，单词之间用下划线分隔（snake_case）。类名应使用大写字母开头的驼峰命名法（CamelCase）。
• 注释 ：请在代码中添加必要的注释，解释代码的功能和逻辑。
• 测试 ：在提交代码之前，请确保您的更改通过了所有现有的测试，并添加新的测试以覆盖您的更改。

许可证

通过为本项目贡献代码，您同意您的贡献将根据项目的许可证进行分发。请确保您有权贡献您提交的代码。

感谢您的贡献！我们期待与您一起改进这个项目。