contribution-guidelines.md

贡献指南

English | 简体中文

我们非常欢迎对本项目进行贡献。以下是一些指导原则和建议，希望能够帮助您参与到项目中来。

贡献代码

如果您想要为项目做出贡献，最好的方式就是提交代码。在提交代码之前，请确保您已经下载并熟悉了项目代码库，并且您的代码遵循了以下指导原则：

• 代码应当尽量简洁明了，并且易于维护和扩展。
• 代码应遵循项目约定的命名规范，以确保代码的一致性。
• 代码应当遵循项目的代码风格指南，可以参考项目代码库中已有的代码。

如果您想向项目提交代码，可以按照以下步骤进行：

• 在 GitHub 上 fork 该项目。
• 克隆您 fork 的项目到本地。
• 在本地进行您的修改和改进。
• 执行测试确保任何更改都无影响。
• 提交您的更改并新建一个 pull request。

代码质量

我们非常注重代码的质量，因此您提交的代码应当符合以下要求：

• 代码应当经过充分的测试，确保其正确性和稳定性。
• 代码应当遵循良好的设计原则和最佳实践。
• 代码应当尽可能地符合您所提交代码贡献的相关要求。

提交信息

在提交代码之前，请确保您提供了有意义而且详细的提交信息。这有助于我们更好地理解您的代码贡献并且更快速地合并它。

提交信息应当包含以下内容：

• 描述本次代码贡献的目的或者原因。
• 描述本次代码贡献的内容或者变化。
• （可选）描述本次代码贡献的测试方法或者结果。

提交信息应当清晰明了，并且符合项目代码库的提交信息约定。

问题报告

如果您在项目中遇到了问题，或者发现了错误，欢迎向我们提交问题报告。在提交问题报告之前，请确保您已经对问题进行了充分的调查和试验，并且尽量提供以下信息：

• 描述问题的现象和表现。
• 描述问题出现的场景和条件。
• 描述上下文信息或任何相关的背景信息。
• 描述您期望的行为信息。
• （可选）提供相关的截图或者报错信息。

问题报告应当清晰明了，并且符合项目代码库的问题报告约定。

功能请求

如果您想要向项目中添加新的功能或者特性，欢迎向我们提交功能请求。在提交功能请求之前，请确保您已经了解了项目的历史和现状，并且尽量提供以下信息：

• 描述您想要添加的功能或者特性。
• 描述这个功能或者特性的用途和目的。
• （可选）提供相关的实现思路或者建议。

功能请求应当清晰明了，并且符合项目代码库的功能请求约定。

感谢您的贡献

最后，感谢您对本项目的贡献。我们欢迎各种形式的贡献，包括但不限于代码贡献、问题报告、功能请求、文档编写等。我们相信在您的帮助下，本项目会变得更加完善和强大。