贡献者指南

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

在本指南中，您将学习如何为 Dapr 文档库做出贡献。由于 Dapr 文档发布在 docs.dapr.io，您需要确保您的贡献能够正确编译和发布。

先决条件

在为 Dapr 文档做贡献之前：

Dapr 文档的分支管理与大多数代码库不同。没有主分支，每个分支都与运行时发布的主要和次要版本相匹配。完整列表请访问 Docs repo。

通常，您所有的文档更新都应提交到 Dapr 最新版本的文档分支。最新版本是默认分支 [https://github.com/dapr/docs]。例如，如果您正在修复拼写错误、添加注释或澄清某个点，请将您的更改提交到默认的 Dapr 分支。

对于适用于候选发布或预发布版本的文档更改，请将您的更改指向该特定分支。例如，如果您正在记录即将对组件或运行时的更改，请将您的更改提交到预发布分支。

在所有 Dapr 文档中应遵循风格和语气惯例，以确保所有文档的一致性：

风格/语气	指导
大小写	仅在以下情况下使用大写：句子或标题的开头专有名词，包括技术名称（Dapr、Redis、Kubernetes 等）
标题和标题	标题和标题必须简洁，但描述性和清晰。
使用简单句子	写出易于阅读、可扫描的句子。提示：跳过正式语气，像直接与读者交谈一样写作。
避免使用第一人称	代替第一人称 “I”、“we” 和 “our”，使用第二人称 “you” 和 “your”。
假设 “新开发者” 受众	对于经验丰富的开发者来说一些看似显而易见的步骤可能对新开发者并不那么明显。为读者提供更明确、详尽的说明。
使用现在时	避免使用诸如 “this command will install Redis” 的句子。相反，使用 “This command installs Redis”。

图表和图像是文档页面中无价的视觉辅助工具。使用 Dapr 图表模板套件中的图表样式和图标。

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

在本指南中，您将学习如何履行 Dapr 文档维护者和审批者的日常职责。要成功完成这些任务，您需要在 dapr/docs 仓库中拥有审批者或维护者的权限。

如果您想了解如何为 Dapr 文档做出贡献，请查看贡献者指南。

Dapr 文档的分支管理与大多数代码仓库不同。没有 main 分支，每个分支都与运行时发布的主要和次要版本相对应。

完整的分支列表请访问文档仓库。

阅读贡献者指南以获取有关发布分支的更多信息。

作为文档审批者或维护者，您需要定期进行合并操作，以确保预发布分支与当前发布分支保持同步。建议每周将当前分支的更新合并到预发布分支。

以下步骤中，将 v1.0 视为当前发布版本，将 v1.1 视为即将发布版本。

在 Visual Studio Code 中打开 Dapr 文档仓库。
在本地仓库中，切换到最新分支 (v1.0) 并同步更改：
```
git pull upstream v1.0
git push origin v1.0
```
切换到即将发布的分支 (v1.1) 并同步更改：
```
git pull upstream v1.1
git push origin v1.1
```
基于即将发布的版本创建一个新分支：
```
git checkout -b upmerge_MM-DD
```
在终端中，从最新发布分支合并到新建的合并分支：
```
git merge --no-ff --no-commit v1.0
```
在终端中，确保合并的文件准确无误。在 VS Code 中检查是否有合并冲突。删除不需要合并的配置更改或版本信息。