开发生命周期¶

概述¶

本页面包含有关文档开发生命周期的所有信息。从这里开始，使用这个图表：

这是一个您可以参考的流程图，其中包含开发过程中发生的事件的时间线¶

flowchart TB
  beta-changes("提交包含更改的PR")
  style beta-changes fill:#3395C2
  beta-pr>Beta PR合并]

  beta-changes-->|批准PR|beta-pr
  beta-branch===beta-pr

  beta-pr --> |部署Beta版本| beta-deployment{{Beta部署}}

  beta-pr === start-beta-release

  start-beta-release --> |部署新的Beta版本| beta-deployment

  subgraph subg ["发布Beta"]
    style subg fill:#0000, stroke:#CCCCCC, stroke-width:5px

    start-beta-release>为发布准备Beta] --> |部署Beta作为最新版本| latest-deployment{{最新部署}}


    start-main-release>为发布准备主分支] ==o merge-beta

    start-beta-release ==> |将Beta与主分支合并| merge-beta>Merge beta]

    start-main-release --> |部署为版本号到旧版本| old-versions[(旧版本)]
  end

  main-branch ==== start-main-release

  merge-beta ==> new-beta-branch>更新Beta分支]
  merge-beta ==> new-main-branch>更新主分支]

  beta-branch>Beta分支]
  main-branch>Main分支]

高亮的蓝色节点是您将更改输入到流程中的地方。您将创建一个Pull Request来让您的代码被审查，然后合并到指定的分支。

选择分支¶

在开始每个您想要工作的更改时，您首先需要确定使用哪个分支。99%的情况下，您应该使用beta分支，这样您的更改就会被包含在文档的未来版本中。

编辑文件¶

开始开发¶

要开始，您将运行docker-compose up来启动Docker容器和实时重载服务器。

修改和保存Markdown文件¶

选择分支后，您将修改任何您想要的Markdown文件并保存更改。保存后，localhost将重新加载，您可以检查您的更改。有关如何修改所有文件以及本文档中包含的特定功能/语法的深入教程，请查看这个页面。

上传更改¶

提交到您的分支¶

在所有编辑完成后，您可以提交更改到您的仓库。您应该遵循以下主要指南：

过多的提交是没有用的。尽管我们希望您将每个更改单独提交为一个提交，但尽量不要做100个提交。
也不要只做一个提交，如果您只修复了一个文件，那么一个提交是没问题的，但如果您编辑了多个文件，那么多个提交将受到赞赏。
使用适当的提交信息；不要只说fixed grammar，请指定页面和您修复的章节。

创建PR¶

在您最终确定编辑并已将所有更改提交到您的分支后，您可以创建一个PR回到文档仓库。同样，提交信息遵循相同的规则，尽量使其具体。提交您的PR后，它将被我们的管理员审查并接受，然后它将进入这里找到的工作流程。

完成¶

您的更改现在将在这里在文档中上线！您可以通过导航到您修改的页面来查看它们。

生命周期¶

这是一个开发生命周期的图表：

flowchart LR
  pick-branch(选择分支) --> start-dev(开始开发) --> make-changes(做出更改) --> errors?{有错误吗?} --> |是| make-changes

  errors? --> |否| commit(提交更改) --> pr(创建PR) --> |PR被批准| merge([合并PR，重新开始]) --> pick-branch

进一步阅读¶

现在您已经了解了编辑文档的基本工作流程，您可以查看这些指南来开始编辑：