贡献指南

感谢您使用 Teek。

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

Issue 规范

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

环境包含

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

参与开发

参考 开发指南。

代码规范

在编写代码时，请注意：

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

提交 Pull Request

参考指南

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

• 第一次参与开源
• 如何优雅地在 GitHub 上贡献代码

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 的标题应该遵循以下格式：

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 前，请依照下面的流程同步主仓库的最新代码：

# 添加主仓库到 remotegitremoteaddupstreamhttps:# 拉取主仓库最新代码gitfetchupstream# 切换至 dev 分支gitcheckoutdev# 合并主仓库代码gitmergeupstream/dev