mmdoc

Appearance

贡献指南 ​

首先,前端文档中心是面向所有人员开放共建的。非常欢迎你为公司的前端知识库添砖加瓦。为了更好的管理文档的发布与保证文档质量。我们设立了一套标准贡献流程。

相信我,这很简单

流程 ​

文档贡献需要按照以下流程:

代码迁出 ​

这是必须的嘛！

bash
git clone git@codeup.aliyun.com:5f855dfb1858a17210466fd0/r_d_center/front-end-catalog.git

你也可以通过其他工具进行代码迁出

新建contribution分支 ​

根据最新master分支新建con-{xxx}分支

环境安装 & 启动 ​

bash
// 安装node_modules依赖。并启动dev开发环境
pnpm install && pnpm dev

启动完毕后。在浏览器中打开http://localhost:8080/即可看到本地文档开发环境

文档贡献 ​

服务启动后。你就可以开始编写文档了。本文档是依据vuepress框架生成的。关于vuepress的内容，你可以阅读他的官方文档
当然大部分时候你只需要了解这几件事即可快速上手

  • 文档都在docs目录下。你所有的编写操作都在这个目录下完成。
  • 文档地址就是你的文件路径地址。
  • 文档使用MarkDown语法

当你编写完成后。将代码推送到远程仓库

PS:新建的文件。需要你重新启动服务

创建合并请求 ​

  • 代码提交到远端后。你需要在公司远程仓库上新建合并请求

contribution_1

  • 选择需要合并的请求分支，并填写必要的描述信息

contribution_2

发布 ​

等待评审员审核完毕。合并进入master分支。文档会自动发布更新🌸🌸🌸

ps: 代码成功合并之后。会删除远端merge分支。所以你也可以删除本地仓库分支了~