element-plus-interactive-docs贡献指南

[FliPPeDround]

element-plus-interactive-docs贡献指南

一、认领任务

请先前往element-plus-histoire文档计划 认领任务，认领任务时请在评论中提供您认领的组件名和预计时间。

eg:

认领`button`组件，预计完成时间为`xxxx-xx-xx`

二、编写文档

使用命令脚本创建模版

pnpm run create

Histoire文档地址

vue3文档
API
Histoire组件

三、提交PR

1. fork项目

请将仓库 fork 至个人空间后再 clone 至本地，官方仓库有权限限制，无法直接提交PR。

2. clone项目

git clone https://github.com/${USER}/element-plus-docs-histoire.git // clone项目 ${USER}为您的用户名

3. 同步代码

// 仅在第一次同步代码时需要执行
git remote add upstream https://github.com/element-plus/element-plus-docs-histoire.git  // 添加上游仓库
git remote -v // 查看远程仓库

在每次提交本地代码前，建议都从上游仓库同步最新代码，否则你可能要额外处理很多冲突。

这样你可以直接在本地通过如下方式将 upstream 官方仓库的改动同步到本地：

git fetch upstream // 获取上游仓库的改动
git rebase upstream/master // 将上游仓库的改动同步到本地

4. 创建分支

在同步官方仓库代码后，请从 master 分支创建新的 feat/fix 分支：

git checkout master // 切换到 master 分支
git checkout -b feat/xxx // 创建新的 feat/fix 分支

5. 提交代码

在本地完成代码修改后，可以通过如下方式将代码提交到远程仓库：

git add . // 将本地代码提交到暂存区
git commit -m 'feat: xxx' // 将暂存区的代码提交到本地仓库并添加提交信息
git push origin feat/xxx // 将本地仓库的代码提交到远程仓库

6. 提交PR

提交代码后你个人的 forked 的仓库主页会出现提示是否发起合并

确认提交内容无误后可以点击 “ Create pull request ” 按钮

7.预览页面

在发起PR后，可以点击此处预览页面