为 Go SDK 贡献

Dapr Go SDK 贡献准则

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

示例

examples 目录中包含了一些代码示例,供用户运行,以尝试各种 Go SDK 包和扩展的特定功能。 在写新的和更新的示例时,请牢记。

  • 所有的例子都应该可以在 Windows、Linux 和 MacOS 上运行。 虽然 Go 代码在操作系统中是一致的,但任何前/后示例命令都应该通过 codetabs 提供选项。
  • 包含下载/安装任何所需先决条件的步骤。 使用全新安装的操作系统的人,应该能够在没有错误的情况下启动这个例子并完成它。 指向外部下载页面的链接是正常的。

Docs

daprdocs 目录包含渲染到 Dapr 文档 网站的 markdown 文件。 当文档网站建立后,该仓库会被克隆和配置,使其内容与文档内容一起呈现。 编写文档时牢记:

  • 除了这些规则外,还应遵循 文档指南
  • 所有文件和目录都应该以 go- 为前缀,以确保所有文件/目录名称在所有 Dapr 文档中是全局唯一的。