贡献指南

感谢你考虑为 VueDir 做出贡献！在提交你的贡献之前，请花点时间阅读以下指南。

📝 代码规范

Prettier 代码格式化

本项目使用 Prettier 来保持一致的代码风格。配置文件位于项目根目录的 .prettierrc：

这些配置确保了：

不使用分号 (semi: false)
使用空格而不是制表符 (useTabs: false)
缩进使用 2 个空格 (tabWidth: 2)
使用单引号 (singleQuote: true)
行长度限制为 120 个字符 (printWidth: 120)
不使用尾随逗号 (trailingComma: "none")

格式化你的代码：

bash

# 格式化所有文件
pnpm format

# 检查代码格式是否符合规范
pnpm format:check

编辑器设置

我们建议在你的编辑器中安装 Prettier 插件，并启用保存时自动格式化：

VS Code: 安装 Prettier 扩展，并在设置中配置 prettier 配置文件路径。
WebStorm/IntelliJ: 在设置中启用 Prettier 集成，配置 Prettier 包路径为项目中的 node_modules/.bin/prettier
其他编辑器: 请参考 Prettier 编辑器集成文档

命名规范

文件名：使用 case（例如：core.ts）
组件名：使用 PascalCase（例如：VFocus）
变量名：使用 camelCase（例如：focusElement）

TypeScript

所有的新代码都应该使用 TypeScript 编写
确保添加适当的类型注解
避免使用 any 类型

提交规范

提交信息应该遵循 Conventional Commits 规范：

bash

feat: add v-focus directive
fix: handle edge case in v-focus
docs: update v-focus documentation
style: format code
refactor: optimize v-focus performance
test: add v-focus unit tests
chore: update dependencies

🔍 提交 PR

更新相关的文档
提交你的改动：

bash

git add .
git commit -m "feat: add new feature"
git push origin feat/your-feature

在你的 fork 仓库中向源仓库创建一个 Pull Request
在 PR 描述中：
- 描述你解决的问题
- 描述你的解决方案
- 提供相关的截图（如果适用）
- 标注是否需要更新文档
等待 PR 被审查和合并

📋 开发清单

在 core/src/directives/ 目录下添加新的指令目录，它应该包括：
- core.ts: 指令的核心逻辑
- index.ts: 指令的入口文件，用于导出指令
- type.ts: 指令的类型定义
- 如果存在svg图标，需要在core/src/icons目录下添加
在 core/src/index.ts 中导出新的指令
在 play/src/App.vue 中测试新的指令
在 docs/.vitepress/config.ts 中添加新的指令到导航栏
在 docs/directives/index.md 中添加新的指令到指令集预览
在 docs/directives/ 目录下添加新的指令文档, 文档格式如下：
- 介绍
- 基础用法
- 其他用法 1
- 其他用法 2
- 其他用法...
- API
- 注意事项
在 docs/.vitepress/components/ 目录下给新的指令添加一个或者多个示例组件
完善文档