蓝图网络
蓝图网是UI组件的综合集合,可供工程团队用于产品 发展。 你可以检查已经交付的组件 在我们 门户。 。 。 .
概览
蓝图网络是下一步 布丽 目前拥有列表的库 缺点。 更多地了解对蓝图的调查和决定 网络 从初步调查开始。 。 。 .
蓝图网的主要好处:
- 不需要从零开始创建 Box 广泛使用的 UI 组件
- 所有组件都放在一个包中
- 所有组件都有最新的UI
- 组件可组成且易于使用
- 寄存器由#蓝印团队维护.
捐款
第1步:创建特性分支
创建带有描述名的分支, 如 add-icon-button。 。 。 .
第2步: 推动您的特性分支
我们用 语义释放 财务报告和审定财务报表 页:1 常规发送消息格式。 。 。 .
为您要处理的每个问题保留一个单独的特性分支 。 当你开发代码时,继续将代码推向您的 特性分支.
承诺信息摘要应是对变化的一刑一刑描述,其长度必须是72个字符或 短一点 对于一个标签列表, 请 点击这里。 。 。 . 见 页:1 默认释放规则 基于承诺标记。 请注意,您必须包含 打破更改的精确关键字“ Breaking Change ” 以学习 更多 点击这里。 。 。 .
下面显示的是基于承诺消息的释放类型实例 .
步骤3:打开拉出请求
请确保您的公关名称包含一个 Jira 票号 - 这将自动更新您的 Jira 票并移动 它的状态.
添加拉动请求描述 - 描述您的变化的预期结果和动机 。 与公关的链接将是: 包含在变更日志中,因此良好的描述将便于理解并提供迁移/使用指南 你的密码.
提交类型
"Semantic sexting"指对包的版本编号(例如. 3.42.11 改为 3.43.0) 已完成
根据说明变化将如何影响消费者的规则。 更多信息
页:1 npm 页。 。 。 .
版本编号被细分为3个位置—— Major.Minor.Patch在语义释出术语中,修改
数字跟着 Breaking.Feature.Fix编辑 semantic-release 脚本解析消息并决定类型
根据上次释放以来发现的犯法行为类型释放.
关于承诺类型的规则是:
- 任何修改或删除 API、选项或输出格式的都是
BREAKING CHANGE。 。 。 . - 任何以倒向相容的方式添加新功能的功能都是一个特征(
feat) (中文(简体) ). 消费者必须升级到 使用该特性的新版本, 但是如果它们这样做, 则不会中断 . - 错误修正( E)
fix对于已存在的行为是一个补丁. 消费者除了升级之外别无他法.- 绩效修正( E)
perf)和还原(revert)作为补丁释放处理. - Box 内部化团队的自动输入会因使用格式而导致补丁
fix(moji): ***。 。 。 .
- 绩效修正( E)
- 其他前缀,例如
docs,不要触发释放,不要出现在更改日志中。 这些标记表示那里 为: 无外部更改 任意 APIs 密码 (包括非破损的). 只有当释放脚本检测到其他可释放的承诺( 壮举/固定)同时出道.build, (中文(简体) ),ci, (中文(简体) ),chore, (中文(简体) ),docs, (中文(简体) ),refactor, (中文(简体) ),style, (中文(简体) ),test
在大多数情况下,犯法行为将构成 feat 或者说 fix确保包括 BREAKING CHANGE 概要中的字符串,如果
承诺中有不可逆的改变.
详见 文件。 。 。 .
软件包安装
如果要使用"蓝图"网络作为软件包,需要将其安装为依赖:
yarn add @box/blueprint-web
蓝图网络需要手动安装某些对等依赖,以防止库重复. 名单 需要的同伴依赖关系,参见 软件包.json。 。 。 .
构成部分发展
如果要开始开发并添加自己的组件,需要先设置项目. 创建库时 无。 。 。 .
先决条件
- 所需数额
node版本为qq20.18
项目设置
为营造发展环境,要采取以下步骤: 一,大力营造发展环境
-
使用 SSH 协议克隆寄存器 引导到这里
-
在根目录中,运行以下命令来运行故事本:
yarn install yarn bootstrap yarn nx storybook blueprint-web
使用蓝图网络组件
此示例显示您可以使用 Button 应用程序中的组件.
样式在导入任何蓝图网络组件时自动导入.
import { Button } from '@box/blueprint-web';
function App() {
return (
<div className="App">
<Button>Button</Button>
</div>
);
}
export default App;
您还需要扩展您的项目 webpack.config.js 下一条规则:
module: {
rules: [
{
test: /\.(js|mjs)$/,
resolve: {
fullySpecified: false, // don't require .mjs extension for module packages
},
},
];
}
项目脚本
yarn nx storybook blueprint-web创建并运行故事书yarn nx test blueprint-web以通过 欢乐yarn nx lint blueprint-web检查林丁yarn nx g @nx/react:component MyNewComponentName --project=blueprint-web --export生成新的 构成部分文档(中文(简体) )yarn nx g @nx/react:component-story --project=blueprint-web --componentPath lib/MyNewComponentName/MyNewComponentName.tsx为您的组件生成新的故事书故事
所有权
这回波是由发射板团队拥有和维护的 你可以在 蓝印 斯克频道.
测试
详见 测试文件。 。 。 .