SDK 贡献指引 on Dapr 文档库

为 .NET SDK 贡献

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

欢迎！

如果你正在阅读这篇文章，说明你可能对为 Dapr 和/或 Dapr .NET SDK 做出贡献感兴趣。欢迎加入这个项目，感谢你对贡献的兴趣！

请查看文档，了解 Dapr 的定义及其目标，并通过 Discord 联系我们。告诉我们你想如何贡献，我们很乐意提供想法和建议。

有很多方式可以为 Dapr 做出贡献：

为 Dapr 运行时或 Dapr .NET SDK 提交错误报告
提出新的运行时功能或 SDK 功能
改进 Dapr 大项目或 Dapr .NET SDK 专门的文档
添加新的或改进现有的组件，以实现各种构建块
增强 .NET 可插拔组件 SDK 功能
改进 Dapr .NET SDK 代码库和/或修复错误（详见下文）

如果你是代码库的新手，请在 Discord 的 #dotnet-sdk 频道中询问如何进行更改或提出一般性问题。你不需要获得许可即可进行任何工作，但请注意，如果某个问题已分配给某人，这表明可能已经有人开始处理它了。特别是如果自上次活动以来已经有一段时间，请随时联系他们，看看他们是否仍然有兴趣继续，或者你是否可以接手，并提交你的实现的 pull request。

如果你想将自己分配给一个问题，请在对话中回复 “/assign”，机器人会将你分配给它。

我们将一些问题标记为 good-first-issue 或 help wanted，表明这些问题可能是小的、独立的更改。

如果你不确定你的实现，请将其创建为草稿 pull request，并通过标记 @dapr/maintainers-dotnet-sdk 向 .NET 维护者征求反馈，并提供一些关于你需要帮助的上下文。

贡献规则和最佳实践

在为 .NET SDK 贡献时，应遵循以下规则和最佳实践。

Pull Requests

仅包含格式更改的 pull request 通常不被鼓励。pull request 应该寻求修复错误、添加新功能或改进现有功能。

为 Go SDK 贡献

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

在为 Go SDK 贡献时，贡献者应该遵循以下规则和最佳实践。

示例

examples 目录包含用户可以运行的代码示例，以尝试各种 Go SDK 包和扩展的特定功能。在编写新的和更新的示例时，请注意：

所有示例应能在 Windows、Linux 和 MacOS 上运行。虽然 Go 代码在不同操作系统之间是一致的，但任何示例的前置/后置命令应通过 tabpane 提供不同的选项。
包含下载和安装任何必要前提条件的步骤。即使是刚安装操作系统的用户，也应该能够顺利开始并完成示例而不出现错误。可以链接到外部下载页面。

文档

daprdocs 目录包含被渲染到 Dapr Docs 网站的 markdown 文件。当文档网站构建时，此仓库会被克隆并配置，以便其内容与文档内容一起呈现。在编写文档时，请注意：

除了这些规则外，还应遵循 docs guide 中的所有规则。
所有文件和目录应以 go- 为前缀，以确保在所有 Dapr 文档中文件和目录名称的全局唯一性。

为 Java SDK 贡献

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

贡献 Java SDK 时，应该遵循以下规则和最佳实践。

示例

examples 目录中包含用户可以运行的代码示例，用于尝试各种 Java SDK 包和扩展的特定功能。在编写或更新示例时，请注意：

所有示例应能在 Windows、Linux 和 MacOS 上运行。虽然 Java 代码在不同操作系统上是一致的，但任何示例的前置或后续命令应通过 tabpane 提供不同的选项。
包含下载和安装所有必要前提条件的步骤。即使是全新安装操作系统的用户，也应该能够顺利开始并完成示例。可以链接到外部下载页面。

文档

daprdocs 目录中包含的 markdown 文件会被渲染到 Dapr Docs 网站上。当文档网站构建时，此仓库会被克隆并配置，以便其内容与文档内容一起渲染。在编写文档时，请注意：

除了这些规则外，还应遵循 docs guide 中的所有规则。
所有文件和目录名称应以 java- 为前缀，以确保在所有 Dapr 文档中具有全局唯一性。

贡献到 JavaScript SDK

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

在为 JavaScript SDK 贡献时，应遵循以下规则和最佳实践。

💡 你可以运行 npm pretty-fix 来格式化所有文件

提交指南

Dapr JavaScript SDK 遵循 Conventional Commits 规范。自动生成的变更日志工具会根据提交信息自动生成变更日志。以下是编写提交信息的指南：

格式

type(scope)!: subject

type: 提交的类型是以下之一：
- feat: 新功能。
- fix: 错误修复。
- docs: 文档更改。
- refactor: 重构特定代码部分，不引入新功能或错误修复。
- style: 代码风格改进。
- perf: 性能改进。
- test: 测试套件的更改。
- ci: CI 系统的更改。
- build: 构建系统的更改（我们目前没有，所以不适用）。
- chore: 其他不符合上述类型的更改。这不会出现在变更日志中。
scope: 提交更改的代码库部分。如果更改了多个部分，或没有特定部分被修改，则留空，不加括号。示例：
- 添加 test 的提交：
```
test(actors): add an actor test
```
- 一次更改多项的提交：
```
style: adopt eslint
```
对于示例的更改，范围应为示例名称，前缀为 examples/：
- ❌ fix(agnoster): commit subject
- ✅ fix(examples/http/actor): commit subject
!: 这个符号放在 scope（或 type 如果范围为空）之后，表示提交引入了重大更改。

为 Python SDK 贡献

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

在贡献 Python SDK 时，应该遵循以下规则和最佳实践。

示例

examples 目录包含用户可以运行的代码示例，以体验各种 Python SDK 包和扩展的特定功能。在编写或更新示例时，请注意：

所有示例应在 Windows、Linux 和 MacOS 上均可运行。虽然 Python 代码在不同操作系统之间是一致的，但任何示例的前置或后续命令应通过 tabpane 提供不同操作系统的选项。
包含下载和安装所有必要前提条件的步骤。即使是刚安装操作系统的人也应该能够顺利开始并完成示例，而不会遇到错误。可以链接到外部下载页面。

文档

daprdocs 目录包含会被渲染到 Dapr Docs 网站的 markdown 文件。当文档网站构建时，此仓库会被克隆并配置，以便其内容与文档内容一起呈现。在编写文档时，请注意：

除了这些规则外，还应遵循 docs guide 中的所有规则。
所有文件和目录名称应以 python- 为前缀，以确保在所有 Dapr 文档中具有唯一性。

Github Dapr Bot 命令

请查看 daprbot 文档以了解您可以在此仓库中使用的 Github 命令来完成常见任务。例如，您可以在问题的评论中运行 /assign 来将问题分配给某个用户或用户组。

贡献 Rust SDK

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

在您为 Rust SDK 贡献时，请遵循以下规则和最佳实践。

示例

examples 目录包含用户可以运行的代码示例，以尝试各种 Rust SDK 包和扩展的特定功能。它还包含用于验证的组件示例。在编写或更新示例时，请注意以下几点：

所有示例应能在 Windows、Linux 和 MacOS 上运行。虽然 Rust 代码在不同操作系统之间基本一致，但由于少量操作系统功能限制，任何示例的前置/后置命令都应通过 tabpane 提供不同选项。
包含下载和安装所有必要前提条件的步骤。刚安装操作系统的人应该能够顺利开始并完成示例而不出错。可以链接到外部下载页面。
示例应经过验证，并包含自动化的 markdown 步骤，并添加到验证工作流 TBA。

文档

daprdocs 目录包含将被渲染到 Dapr Docs 网站的 markdown 文件。当文档网站构建时，此仓库会被克隆并配置，以便其内容与文档内容一起渲染。在编写文档时，请注意：

除了这些规则外，还应遵循 docs guide 中的所有规则。
所有文件和目录应以 rust- 为前缀，以确保在所有 Dapr 文档中文件/目录名称的全局唯一性。

更新 Protobufs

要从 dapr/dapr 仓库中提取 protobufs，您可以在仓库根目录运行以下脚本：

./update-protos.sh

默认情况下，脚本从 Dapr 仓库的 master 分支获取最新的 proto 更新。如果您需要选择特定的发布或版本，请使用 -v 标志：

./update-protos.sh -v v1.13.0