Skip to content

Latest commit

 

History

History
210 lines (141 loc) · 5.78 KB

CONTRIBUTING.md

File metadata and controls

210 lines (141 loc) · 5.78 KB
Raw

CloudBase CMS 贡献指南

成为贡献者

感谢您有兴趣成为 CloudBase CMS 社区贡献者！

您可以选择如下的贡献方式：

  • 贡献一篇技术文章
  • 贡献代码，提交 Pull Request
  • 反馈 bug，提交 Issue
  • 在技术会议上发表技术演讲

我们会将您加入我们的贡献者名单

本地开发

安装 @cloudbase/cli

使用 Node 包管理器 NPM 安装最新版本的 CloudBase CLI 工具（1.0.0+）

npm install -g @cloudbase/cli@latest

登录 CLI

具体的登录方法请参考 CLI 的登录说明文档

tcb login

配置

下面的配置仅为演示，不代表真实的配置，实际配置以项目最新源码中的配置文件为准。

  1. 复制根目录下的 .env.example 为 .env.local，并根据文件中的内容进行配置

    # 您的云开发环境 Id
ENV_ID=
# 管理员账户名，账号名长度需要大于 4 位，支持字母和数字
administratorName=
# 管理员账号密码，8~32位，密码支持字母、数字、字符、不能由纯字母或存数字组成
administratorPassword=
# CMS 控制台路径，如 /tcb-cms/，建议使用根路径 /
deployPath=
# 云接入自定义域名（选填），如 tencent.com
accessDomain=

  2. 复制 packages/service/.env.example 为 packages/service/.env.local，并根据文件中的内容进行配置

    TCB_ENVID=
SECRETID=
SECRETKEY=

  3. 复制 packages/admin/public/config.example.js 为 packages/admin/public/config.js，并根据文件中的内容进行配置

    window.TcbCmsConfig = {
  // 可用区，默认上海，可选：ap-shanghai 或 ap-guangzhou
  region: 'ap-shanghai',
  // 路由方式：hash 或 browser
  history: 'hash',
  // 环境 Id
  envId: 'envId',
  // 禁用通知
  disableNotice: false,
  // 禁用帮助按钮
  disableHelpButton: false,
  // 云接入默认域名/自定义域名 + 云接入路径，不带 https 协议符
  // https://console.cloud.tencent.com/tcb/env/access
  cloudAccessPath: 'xxx-xxx.service.tcloudbase.com/tcb-ext-cms-service',
}

安装依赖

# 安装 lerna 依赖
npm install
# 安装 package 依赖
npm run setup

部署

npm run deploy

启动开发

运行下面的命令，成功后，可以访问 http://localhost:8000/ 打开 CMS 管理界面

cd packages/admin && npm run dev
cd packages/service && npm run dev

部署测试

参考源码部署说明文档。

提交代码规范

遵循 Angular 提出的Angular 提交信息规范

请使用 npm run commit 进行提交代码，提交格式如下：

<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

每次提交可以包含页眉(header)、正文(body)和页脚(footer)，每次提交必须包含页眉内容

每次提交的信息不超过100个字符

详细文档：AngularJS Git Commit Message Conventions

页眉设置

页眉的格式指定为提交类型(type)、作用域(scope，可选)和主题(subject)

提交类型

提交类型指定为下面其中一个：

  1. build：对构建系统或者外部依赖项进行了修改
  2. ci：对 CI 配置文件或脚本进行了修改
  3. docs：对文档进行了修改
  4. feat：增加新的特征
  5. fix：修复bug
  6. pref：提高性能的代码更改
  7. refactor：既不是修复bug也不是添加特征的代码重构
  8. style：不影响代码含义的修改，比如空格、格式化、缺失的分号等
  9. test：增加确实的测试或者矫正已存在的测试
  10. chore： 一些琐碎的细节，如样式微调，文案修改等

作用域

范围可以是任何指定提交更改位置的内容

主题

主题包括了对本次修改的简洁描述，有以下准则

  1. 使用命令式，现在时态：“改变”不是“已改变”也不是“改变了”
  2. 不要大写首字母
  3. 不在末尾添加句号

正文设置

和主题设置类似，使用命令式、现在时态

应该包含修改的动机以及和之前行为的对比

页脚设置

Breaking changes

不兼容修改指的是本次提交修改了不兼容之前版本的API或者环境变量

所有不兼容修改都必须在页脚中作为中断更改块提到，以BREAKING CHANGE:开头，后跟一个空格或者两个换行符，其余的信息就是对此次修改的描述，修改的理由和修改注释

BREAKING CHANGE: isolate scope bindings definition has changed and
    the inject option for the directive controller injection was removed.

    To migrate the code follow the example below:

    Before:

    。。。
    。。。

    After:

    。。。
    。。。

    The removed `inject` wasn't generaly useful for directives so there should be no code using it.

引用提交的问题

如果本次提交目的是修改issue的话，需要在页脚引用该issue

以关键字Closes开头，比如

Closes #234

如果修改了多个bug，以逗号隔开

Closes #123, #245, #992

回滚设置

当此次提交包含回滚(revert)操作，那么页眉以"revert:"开头，同时在正文中添加"This reverts commit hash"，其中hash值表示被回滚前的提交

revert:<type>(<scope>): <subject>
<BLANK LINE>
This reverts commit hash
<other-body>
<BLANK LINE>
<footer>