CONTRIBUTING.zh-CN.md

贡献指南

  非常感谢您对Dora SSR的兴趣和支持！我们欢迎任何人为这个项目做出贡献。以下是一些建议和指南，以帮助您开始参与项目的贡献。

报告问题

  如果您在使用Dora SSR时发现了问题，请在GitHub仓库中提交一个Issue。在提交Issue之前，请确保：

1. 查看已有的Issue，避免重复报告。

2. 详细描述问题，包括预期行为和实际发生的行为。

3. 如果可能，请提供一个简单的重现问题的示例代码。

功能建议

  我们非常欢迎您对Dora SSR提出新功能的建议。在提交功能建议之前，请确保：

1. 您的建议与Dora SSR的目标和愿景保持一致。

2. 提供足够的细节，以便我们理解您的需求和建议的实现方式。

代码贡献

  如果您想要为Dora SSR贡献代码，请遵循以下步骤：

1. Fork 项目：

   Fork 项目仓库。

2. 创建分支：

   在本地创建一个新的分支，以便进行更改。

3. 从源代码构建：

   通过参考从源代码构建的文档，熟悉项目从源代码编译的过程。

4. 进行编码：

   编写代码并确保代码符合项目的编码规范。

   编码风格指南：

   • 我们希望遵循同一种编码书写的风格，以保持项目的一致性和可读性。我们的风格定义在位于此处的 clang-format 配置文件中。
   • 提交代码之前，请确保对代码运行 clang-format 对代码做格式化的处理。

5. 提交和推送：

   提交更改并将它们推送到您的 fork 仓库。

6. 提交 Pull Request：

   创建一个 Pull Request，详细描述你的更改及其理由。

贡献文档

  文档对于开源项目的成功至关重要。如果您发现了文档中的错误，或者您认为可以改进文档，请提交Issue或Pull Request。

开发者认证协议 (DCO)

通过为这个项目做出贡献，您同意开发者认证协议的条款。这意味着：

1. 您提交的代码是您自己的，或者您有权贡献它。
2. 您同意将您的贡献在与项目相同的许可证下进行许可。

为了表明您接受这些条款，您必须在提交信息中包含一行 Signed-off-by：

Signed-off-by: Your Name youremail@example.com

您可以在提交时运行 git commit -s 来自动添加这一行。

社区支持

  您可以通过回答问题、提供教程和示例项目等方式为社区提供支持。如果您有任何可以帮助其他开发者的资源，请分享在社区相关的论坛和聊天室中。

---

  希望这个贡献指南能帮助您开始参与Dora SSR项目。再次感谢您的支持，期待您的贡献！