贡献指南

介绍

感谢你使用 Wot Design Uni。

以下是关于向 Wot Design Uni 提交反馈或代码的指南。在向 Wot Design Uni 提交 issue 或者 PR 之前，请先花几分钟时间阅读以下内容。

Issue 规范

遇到问题时，请先确认这个问题是否已经在 issue 中有记录或者已被修复。
提 issue 时，请用简短的语言描述遇到的问题，并添加出现问题时的环境和复现步骤。
如果在提问前，无法确认怎样的一个问题是好的、更容易被回复的问题，可以读一读提问的智慧。

参与开发

请先 fork 一份组件库源码到自己的 github。
使用 git clone 将自己 github 上 fork 得到的源码同步到到你的本地
请确保基于 master 分支进行开发，我们只接受此分支上的代码贡献。

镜像仓库

如果 GitHub 克隆速度较慢，你也可以直接克隆 Wot Design Uni 在 gitee 上的镜像仓库：

git clone https://gitee.com/fant-mini/wot-design-uni.git

镜像仓库仅用于加快国内的访问速度，请勿在镜像仓库中提 issue 和 Pull Request。

代码规范

在编写代码时，请注意：

确保代码可以通过仓库的 ESLint 校验。
确保代码格式是规范的，使用 prettier 进行代码格式化。

关于新功能

新功能需要标注最低版本号，如何确定版本号呢？当然没那么复杂啦！只需要各位贡献者在/docs/*.md内需要显示最低版本号的地方写上 $LOWEST_VERSION$ 占位符即可；当下一次发版时，脚手架将会自动确定版本号并替换全部/docs/*.md中的 $LOWEST_VERSION$ 占位符

| 参数  | 说明            | 类型     | 可选值    | 默认值    | 最低版本           |
| ----- | --------------- | ------ | --------- | --------- | ---------------- |
| text  | 设置通知栏文案  | `string` | -         | -         | $LOWEST_VERSION$ |

Commit

开发之后，在 commit 代码时，commit message 请遵循以下格式：

如不按照此以下格式，git commit 可能无法正常工作。

<Commit 类型>(Commit 修改项): <commit 描述>
// 或者
<Commit 类型>: <commit 描述>

例如：

npm run commit
# 或者
yarn commit

# 或者
pnpm commit

## 执行命令后根据修改类型选择

commit 类型

[
  {
    "type": "feat",
    "section": "✨ Features | 新功能",
    "hidden": false
  },
  {
    "type": "fix",
    "section": "🐛 Bug Fixes | Bug 修复",
    "hidden": false
  },
  {
    "type": "init",
    "section": "🎉 Init | 初始化",
    "hidden": true
  },
  {
    "type": "docs",
    "section": "✏️ Documentation | 文档",
    "hidden": false
  },
  {
    "type": "style",
    "section": "💄 Styles | 风格",
    "hidden": true
  },
  {
    "type": "refactor",
    "section": "♻️ Code Refactoring | 代码重构",
    "hidden": true
  },
  {
    "type": "perf",
    "section": "⚡ Performance Improvements | 性能优化",
    "hidden": true
  },
  {
    "type": "test",
    "section": "✅ Tests | 测试",
    "hidden": true
  },
  {
    "type": "revert",
    "section": "⏪ Revert | 回退",
    "hidden": true
  },
  {
    "type": "build",
    "section": "📦‍ Build System | 打包构建",
    "hidden": true
  },
  {
    "type": "chore",
    "section": "🚀 Chore | 构建/工程依赖/工具",
    "hidden": true
  },
  {
    "type": "ci",
    "section": "👷 Continuous Integration | CI 配置",
    "hidden": true
  }
]

commit 描述

commit 描述说明了我们本次提交的具体描述，具体内容视情况而定，无固定规范。

提交 Pull Request

参考指南

如果你是第一次在 GitHub 上提 Pull Request ，可以阅读下面这两篇文章来学习：

Pull Request 规范

在提交 Pull Request 时，请注意：

保持你的 PR 足够小，一个 PR 只解决单个问题或添加单个功能。
当新增组件或者修改原有组件时，记得增加或者修改对应的文档、Usage和暗黑模式样式。
在 PR 中请添加合适的描述，并关联相关的 Issue。

Pull Request 流程

fork 主仓库，如果已经 fork 过，请同步主仓库的最新代码。
基于 fork 后仓库的 master 分支新建一个分支，比如 feature/add_button。
在新分支上进行开发，开发完成后，提 Pull Request 到主仓库的 main 分支。
Pull Request 会在 Review 通过后被合并到主仓库。
等待组件库发布新版本。

Pull Request 标题格式

Pull Request 的标题应该遵循以下格式：

type：commit message

示例：

docs: fix typo in quickstart
build: optimize build speed
fix: incorrect style
feat: add color prop

可选的类型：

fix
feat
docs
perf
test
types
style
build
chore
release
refactor
breaking change
revert

同步最新代码

提 Pull Request 前，请依照下面的流程同步主仓库的最新代码：

# 添加主仓库到 remote
git remote add upstream https://github.com/Moonofweisheng/wot-design-uni.git

# 拉取主仓库最新代码
git fetch upstream

# 切换至 master 分支
git checkout master

# 合并主仓库代码
git merge upstream/master

Gitee 极速下载 / wot-design-uni0

贡献指南

介绍

Issue 规范

参与开发

镜像仓库

代码规范

关于新功能

Commit

commit 类型

commit 描述

提交 Pull Request

参考指南

Pull Request 规范

Pull Request 流程

Pull Request 标题格式

同步最新代码

简介

发行版

贡献者

近期动态

Gitee 极速下载 / wot-design-uni0 .gitee-modal { width: 500px !important; }

贡献指南

介绍

Issue 规范

参与开发

镜像仓库

代码规范

关于新功能

Commit

commit 类型

commit 描述

提交 Pull Request

参考指南

Pull Request 规范

Pull Request 流程

Pull Request 标题格式

同步最新代码

简介

发行版

贡献者

近期动态

搜索帮助

Gitee 极速下载 / wot-design-uni0