One

主题

贡献指南 ​

如何提pr ​

image-20250326184120817

前言 ​

感谢您使用 Teek。

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

1、Issue 规范 ​

  • 遇到问题时，请先确认这个问题是否已经在 Issue 中有记录或者已被修复
  • 提 Issue 时，请用简短的语言描述遇到的问题，并添加出现问题时的环境和复现步骤，必要时需提供可复现问题最小代码仓库

环境包含

  • 浏览器 版本
  • 操作系统 版本
  • node 版本
  • vitepress 版本
  • Teek 版本

2、参与开发 ​

参考 开发指南。

代码规范 ​

在编写代码时，请注意：

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

3、提交 Pull Request ​

参考指南 ​

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

Pull Request 规范 ​

在提交 Pull Request 时，请注意：

  • 保持你的 PR 足够小，一个 PR 只解决单个问题或添加单个功能
  • 在 PR 中请添加合适的描述，并关联相关的 Issue

Pull Request 流程 ​

  1. fork 主仓库，如果已经 fork 过，请同步主仓库的最新代码
  2. 基于 fork 后仓库的 dev 分支新建一个分支，比如 feature/docs
  3. 在新分支上进行开发，开发完成后，提 Pull Request 到主仓库的 dev 分支
  4. Pull Request 会在 Review 通过后被合并到主仓库
  5. 等待 Teek 发布新版本

Pull Request 标题格式 ​

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

sh
type(scoped)：commit message

示例：

  • docs: add contribution.md
  • build: optimize build speed
  • fix(component(icon)): incorrect style
  • feat(hooks(useVpRouter)): add new function

可选的类型：

  • feat
  • fix
  • docs
  • style
  • refactor
  • perf
  • test
  • build
  • ci
  • chore
  • revert
  • wip
  • types

同步最新代码 ​

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

sh
# 添加主仓库到 remote
git remote add upstream https://github.com/Kele-Bingtang/vitepress-theme-teek.git

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

# 切换至 dev 分支
git checkout dev

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

4、亲自测试提pr😜 ​

bash
（1）基于作者原仓库 fork 仓库到自己github账户

（2）将自己github账户仓库拉取到本地
cd /d/teek-pr/
git clone git@github.com:OnlyOnexl/vitepress-theme-teek.git
cd vitepress-theme-teek

##查看下
git branch -av
git remote -v

# 添加主仓库到 remote （如果尚未添加）
git remote add upstream https://github.com/Kele-Bingtang/vitepress-theme-teek.git

cd /d/teek-pr/vitepress-theme-teek
git log -10 --oneline origin/dev
git log -10 --oneline origin/master


（4）推送新功能到 自己github账户 远程仓库
#创建新分支
git checkout dev

git checkout -b teek-one #基于dev分支创建teek-one分支
git add -A
git commit -m"feat: 🚀 demo网站风格新增 时间线 和 五彩纸屑 功能"
git push origin teek-one

（5）再到自己github 仓库手动提交pr
#创建 Pull Request：回到 GitHub，进入你 Fork 的仓库页面，点击 "Compare & pull request" 按钮，填写相关信息并提交 PR。
#等待审核：仓库的维护者会审核你的 PR，可能会提出修改意见或直接合并你的更改。

（6）更新代码

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

# 切换至 teek-one 分支
git checkout teek-one

# 合并主仓库代码(将upstream/dev  合并到 teek-one分支)
git merge upstream/dev

##再次修改代码
git add -A
git commit -m"feat: 🚀 demo网站风格新增 时间线 和 五彩纸屑 功能"
git push origin teek-one


##其它
pnpm i
pnpm to:theme stub
pnpm demo:base dev

结束。