贡献概述

为任何Dapr项目资源库做出贡献的通用指南

感谢您对 Dapr的兴趣! 感谢您对 Dapr的兴趣! 本文档提供了有关如何通过问题和拉取请求对 Dapr 项目 作出贡献的指南。 贡献还可以通过多种方式来实现,如举办线下活动,参加社区会议,评论问题或拉取请求等。

了解有关社区参与和社区成员的更多信息,请参阅 Dapr community repository

如果你想为Dapr文档做出贡献,还请参阅 <a href=”https://docs.dapr.io/zh-hans/contributing/contributing-docs/&gt; 投稿准则 。

Issues

Issue类型

在大多数 Dapr 存储库中,通常有 4 种类型的问题:

  • Issue/Bug: 你发现了代码中的一个错误,想要报告它,或者创建一个问题来跟踪这个错误。
  • Issue/Discussion: 你有一些想法,需要别人在讨论中提出意见,最终才会体现为一个建议。
  • Issue/Proposal: 用于提出新想法或功能的项目。 这样就可以在编写代码之前得到别人的反馈。
  • Issue/Question: 如果您需要帮助或有问题,请使用此问题类型。

提交前

在提交问题之前,请确保检查了以下内容:

  1. 是正确的存储库吗?
    • Dapr 项目分布在多个存储库中。 如果你不确定哪个repo是正确的,请检查repositories的列表。
  2. 检查现有问题
    • 在创建新问题之前,请在 open issues 中进行搜索,以查看问题或功能请求是否已经被提交。
    • 如果发现问题已存在,请进行相关注释并添加 reaction。 添加回应
      • 👍 赞同投票
      • 👎 反对投票
  3. 对于bugs
    • 检查它不是环境问题。 例如,如果在 Kubernetes 上运行,请确保先决条件已到位。 (状态存储,绑定等)
    • 您有尽可能多的数据。 这通常以日志和/或堆栈跟踪的形式出现。 如果在 Kubernetes 或其他环境中运行,请查看 Dapr 服务的日志 (运行时,操作员和安置服务) 。 有关如何获取日志的更多详细信息,请在此处.
  4. 对于建议
    • 对 Dapr 运行时的许多更改可能需要对 API 进行更改。 在此情况下,讨论潜在功能的最佳位置是 Dapr repo
    • 其他的例子可以包括绑定、状态存储或全新的组件。

Pull Requests

所有的贡献都是通过拉请求来实现的。 要提交拟议的更改,请遵循此工作流程。

  1. 确保有一个问题(bug或建议)被提出,这为你即将做出的贡献设定了期望。
  2. Fork相关的repo并创建一个新的分支。
  3. 创建更改
    • 代码更改需要测试
  4. 更新有关更改的相关文档
  5. 提交并打开一个 PR
  6. 等待 CI 进程完成并确保所有检查都是绿色的
  7. 项目的维护者将被指定,您可以在几天内得到审查。

使用正在进行的 PRs 进行早期反馈

在投入太多时间之前,一个好的沟通方式是创建一个 “Work-in-progress “的PR,并与你的审阅者分享。 标准的方法是在PR的标题中添加 “[WIP]” 前缀,并分配 do-not-merge 标签。 这将使查看您的 PR 的人知道它还没有准备好。

使用第三方代码

  • 第三方代码必须包含许可证。

行为准则

请参阅 Dapr 社区行为准则

Last modified January 1, 0001