为Dapr项目做贡献 on Dapr 文档库

贡献概览

Mon, 01 Jan 0001 00:00:00 +0000

感谢您对Dapr项目的关注！本文档为您提供如何通过提交问题和拉取请求来为Dapr项目做出贡献的指南。您还可以通过其他方式参与，例如参加社区电话会议、对问题或拉取请求进行评论等。

有关社区参与和成员资格的更多信息，请参阅Dapr社区代码库。

Dapr代码库索引

以下是Dapr组织下的代码库列表，您可以在这些代码库中进行贡献：

文档：此代码库包含Dapr的文档。您可以通过更新现有文档、修复错误或添加新内容来改善用户体验和清晰度。请参阅文档贡献指南。
快速入门：快速入门代码库提供简单的分步指南，帮助用户快速上手Dapr。您可以通过创建新的快速入门、改进现有的快速入门或确保它们与最新功能保持同步来贡献。查看贡献指南。
运行时：Dapr运行时代码库包含核心运行时组件。您可以通过修复错误、优化性能、实现新功能或增强现有功能来贡献。
组件贡献：此代码库托管了Dapr的社区贡献组件集合。您可以通过添加新组件、改进现有组件或审查和测试社区的贡献来参与。
SDKs：Dapr SDKs为各种编程语言提供与Dapr交互的库。您可以通过改进SDK功能、修复错误或添加对新功能的支持来贡献。请参阅SDK贡献指南以获取特定SDK的详细信息。
CLI：Dapr CLI用于在本地开发机器或Kubernetes集群上设置Dapr以启动和管理Dapr实例。对CLI代码库的贡献包括添加新功能、修复错误、提高可用性，并确保与最新的Dapr版本兼容。请参阅开发指南以获取有关开发Dapr CLI的帮助。

问题

问题类型

在大多数Dapr代码库中，通常有4种类型的问题：

问题/错误：您发现了代码中的错误，并希望报告或创建一个问题来跟踪该错误。
问题/讨论：您有一些想法，需要在讨论中获得他人的意见，然后最终形成提案。
问题/提案：用于提出新想法或功能的项目。这允许在编写代码之前获得他人的反馈。
问题/问题：如果您需要帮助或有问题，请使用此问题类型。

提交之前

在提交问题之前，请确保您已检查以下内容：

这是正确的代码库吗？
- Dapr项目分布在多个代码库中。如果您不确定哪个代码库是正确的，请查看代码库列表。
检查现有问题
- 在创建新问题之前，请在开放问题中搜索，查看该问题或功能请求是否已被提交。
- 如果您发现您的问题已经存在，请进行相关评论并添加您的反应。使用反应：
  - 👍 赞成
  - 👎 反对
对于错误
- 检查这不是环境问题。例如，如果在Kubernetes上运行，请确保先决条件已到位。（state存储、bindings等）
- 您拥有尽可能多的数据。这通常以日志和/或堆栈跟踪的形式出现。如果在Kubernetes或其他环境中运行，请查看Dapr服务（运行时、operator、placement服务）的日志。有关如何获取日志的更多详细信息，请参阅此处。
对于提案
- 许多对Dapr运行时的更改可能需要对API进行更改。在这种情况下，讨论潜在功能的最佳地点是主要的Dapr代码库。
- 其他示例可能包括bindings、state存储或全新的组件。

拉取请求

所有贡献都通过拉取请求提交。要提交建议的更改，请遵循以下工作流程：

确保已提出问题（错误或提案），以设定您即将进行的贡献的期望。
分叉相关代码库并创建新分支
- 一些Dapr代码库支持Codespaces，为您提供即时环境以构建和测试您的更改。
- 有关设置Dapr开发环境的更多信息，请参阅开发Dapr文档。
创建您的更改
- 代码更改需要测试
更新相关文档以反映更改
使用DCO签署提交并打开PR
等待CI过程完成并确保所有检查通过
项目的维护者将被分配，您可以在几天内期待审查

使用草稿PR以获得早期反馈

在投入过多时间之前进行沟通的好方法是创建一个“草稿”PR并与您的审阅者分享。标准做法是在PR的标题中添加“[WIP]”前缀，并分配do-not-merge标签。这将让查看您PR的人知道它尚未成熟。

使用第三方代码

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

开发者来源证书：签署您的工作

每次提交都需要签署

开发者来源证书（DCO）是一种轻量级方式，供贡献者证明他们编写或以其他方式有权提交他们贡献给项目的代码。以下是DCO的完整文本，经过重新格式化以提高可读性：

通过对该项目进行贡献，我证明：
 (a) 该贡献完全或部分由我创建，并且我有权根据文件中指明的开源许可证提交它；或者
 (b) 该贡献基于我所知的适当开源许可证覆盖的先前工作，并且我有权根据该许可证提交该工作及其修改，无论是由我完全或部分创建的，均根据相同的开源许可证（除非我被允许根据不同的许可证提交），如文件中所示；或者
 (c) 该贡献是由其他人直接提供给我的，他们证明了(a)、(b)或(c)，而我没有修改它。
 (d) 我理解并同意该项目和贡献是公开的，并且贡献的记录（包括我提交的所有个人信息，包括我的签署）将被无限期地维护，并可能根据该项目或涉及的开源许可证进行再分发。

贡献者通过在提交消息中添加Signed-off-by行来签署他们遵守这些要求。

这是我的提交消息
Signed-off-by: Random J Developer <random@developer.example.org>

Git甚至有一个-s命令行选项，可以自动将其附加到您的提交消息中：

Dapr 演讲指南

Mon, 01 Jan 0001 00:00:00 +0000

我们欢迎社区成员分享关于 Dapr 的演讲，并推广 Dapr 的各种强大功能！我们提供了一个 PowerPoint 模板文件，帮助您快速开始。

下载 Dapr 演示文稿

如果您在 MacOS 上使用 PowerPoint 模板，请安装 Space Grotesk 字体以确保文本正确显示：

brew install --cask font-space-grotesk

如何进行 Dapr 演讲

首先下载 Dapr 演示文稿，其中包含您进行 Dapr 演讲所需的幻灯片和图表。
接下来，查看文档以确保您理解概念。
使用 Dapr 快速入门和示例仓库，展示如何使用 Dapr。

过往的 Dapr 演讲

演讲	录音	幻灯片
在 Kubernetes 中运行事件驱动的 Pub/Sub 微服务与 Dapr	链接	N/A
Ignite 2019: Mark Russinovich 展示云原生应用的未来	链接	链接
Azure Community Live: 使用 DAPR 构建微服务应用与 Mark Fussell	链接	N/A
Ready 2020: Mark Russinovich 展示云原生应用	链接	链接
Ignite 2021: Mark Russinovich 发布 Dapr v1.0	链接	N/A

其他资源

在社区仓库中可以找到更多 Dapr 资源。

Dapr 发展规划

Mon, 01 Jan 0001 00:00:00 +0000

请访问此文档以了解 Dapr 项目的发展规划。

使用 GitHub Codespaces 进行贡献

Mon, 01 Jan 0001 00:00:00 +0000

GitHub Codespaces 是为 Dapr 仓库做出贡献的最简单方式。只需点击一下，您就可以在浏览器中获得一个已准备好的环境，包含所有必要的前置条件。

功能

一键运行：获取一个专用且沙盒化的环境，所有必需的框架和包都已准备就绪。
按使用计费：只需为您在 Codespaces 中开发的时间付费。当不使用时，环境会自动关闭。
便携性：可以在浏览器中运行，也可以在 Visual Studio Code 中运行，或使用 SSH 连接。

在 Codespace 中打开 Dapr 仓库

要在 Codespace 中打开 Dapr 仓库，请从仓库主页选择“Code”并选择“Open with Codespaces”：

如果您还没有 fork 该仓库，创建 Codespace 时会自动为您创建一个 fork，并在 Codespace 中使用它。

支持的仓库

在 Codespace 中开发 Dapr 组件

开发新的 Dapr 组件需要同时处理 dapr/components-contrib 和 dapr/dapr 仓库。建议将这两个文件夹并排放置在 /workspaces 目录中。

如果您从 `dapr/dapr` 创建了 Codespace

如果您的 Codespaces 是从 dapr/dapr 仓库或其 fork 启动的，您需要在 /workspaces/components-contrib 中克隆 dapr/components-contrib 仓库（或其 fork）。

Dapr 机器人参考

Mon, 01 Jan 0001 00:00:00 +0000

Dapr 机器人通过一系列命令来帮助处理 Dapr 组织中的常见任务。它可以为每个代码库单独配置（示例），并能够在特定事件发生时运行。以下是命令列表及其在各个代码库中的实现。

命令参考

命令	目标	描述	谁可以使用	代码库
`/assign`	Issue	将一个 issue 分配给一个或多个用户	任何人	`dapr`, `docs`, `quickstarts`, `cli`, `components-contrib`, `go-sdk`, `js-sdk`, `java-sdk`, `python-sdk`, `dotnet-sdk`, `rust-sdk`
`/ok-to-test`	Pull request	`dapr`: 触发端到端测试 `components-contrib`: 触发一致性和认证测试	在 bot 中授权的用户	`dapr`, `components-contrib`
`/ok-to-perf`	Pull request	触发性能测试。	在 bot 中授权的用户	`dapr`
`/make-me-laugh`	Issue 或 pull request	发布一个随机笑话，增添趣味	在 bot 中授权的用户	`dapr`, `components-contrib`

标签参考

您可以通过使用 created-by/dapr-bot 标签查询由 Dapr 机器人创建的 issue（查询）。

标签	目标	作用说明	代码库
`docs-needed`	Issue	在 `dapr/docs` 中创建一个新的 issue 以跟踪文档工作	`dapr`
`sdk-needed`	Issue	在 SDK 仓库中创建新的 issue 以跟踪 SDK 工作	`dapr`
`documentation required`	Issue 或 pull request	在 `dapr/docs` 中创建一个新的 issue 以跟踪文档工作	`components-contrib`
`new component`	Issue 或 pull request	在 `dapr/dapr` 中创建一个新的 issue 以注册新组件	`components-contrib`

为Dapr项目做贡献 on Dapr 文档库

贡献概览

Dapr代码库索引

问题

问题类型

提交之前

拉取请求

使用草稿PR以获得早期反馈

使用第三方代码

开发者来源证书：签署您的工作

每次提交都需要签署

Dapr 演讲指南

如何进行 Dapr 演讲

过往的 Dapr 演讲

其他资源

Dapr 发展规划

使用 GitHub Codespaces 进行贡献

功能

在 Codespace 中打开 Dapr 仓库

支持的仓库

在 Codespace 中开发 Dapr 组件

如果您从 dapr/dapr 创建了 Codespace

Dapr 机器人参考

命令参考

标签参考

如果您从 `dapr/dapr` 创建了 Codespace