贡献指南
感谢你对 vite-plugin-zip-pack 项目的关注！我们欢迎所有形式的贡献，无论是代码、文档、问题报告还是功能建议。
如何贡献
报告 Bug
如果你发现了 bug，请：
- 先查看 常见问题 和 GitHub Issues 确认是否已有相关问题
- 如果不存在，请创建新的 Issue，包含：
- 清晰的 bug 描述
- 复现步骤
- 预期行为 vs 实际行为
- 环境信息（Node.js 版本、Vite 版本、操作系统等）
- 相关代码或配置
- 错误日志（如果有）
提出功能建议
如果你有好的想法或功能建议：
- 先查看现有 Issues 确认是否已有类似建议
- 创建新的 Issue，详细描述：
- 功能需求和使用场景
- 预期的实现方式（可选）
- 可能的替代方案
贡献代码
我们欢迎代码贡献！请遵循以下流程：
开发环境设置
- Fork 153264/vite-plugin-zip-pack 并 Clone 到本地：
bash
git clone https://github.com/<your-username>/vite-plugin-zip-pack.git
cd vite-plugin-zip-pack- 安装依赖：
bash
npm install
# 或
pnpm install- 创建新的功能分支：
bash
git checkout -b feature/your-feature-name
# 或修复 bug
git checkout -b fix/your-bug-fix代码规范
请严格遵循以下代码标准：
- 缩进: 使用 4 个空格（不是 Tab）
- 注释: 代码注释请使用英文
- 代码风格: 遵循项目现有的 ESLint 和 Prettier 配置
- 测试: 新功能需要添加相应的测试用例
- 类型: 确保 TypeScript 类型定义完整
运行代码检查：
bash
# 检查代码风格
npm run lint:check
# 自动修复
npm run lint:fix
# 检查格式
npm run format:check
# 自动格式化
npm run format:fix运行测试
bash
# 运行测试
npm test
# 运行测试并生成覆盖率报告
npm run test:coverage提交代码
- 确保代码通过所有检查（lint、format、test）
- 提交代码（遵循 Conventional Commits 规范）：
bash
git add .
git commit -m "feat: add new feature"
# 或
git commit -m "fix: fix bug description"- 推送到你的分支：
bash
git push origin feature/your-feature-name- 在 GitHub 上创建 Pull Request：
- 提供清晰的 PR 描述
- 说明变更内容和原因
- 关联相关的 Issue（如果有）
- 添加截图或示例（如果适用）
PR 审查流程
- 维护者会审查你的 PR
- 可能需要一些修改或讨论
- 审查通过后，PR 会被合并到主分支
更新文档
文档的改进同样重要！文档源代码位于 docs/ 目录。
文档贡献流程
- Fork 项目并创建新分支：
bash
git checkout -b docs/your-doc-improvement- 编辑文档文件（Markdown 格式）
- 本地预览（如果使用 VitePress）：
bash
npm run docs:dev- 提交并创建 PR
文档规范
- 使用清晰、简洁的语言
- 提供代码示例
- 保持格式一致
- 添加适当的链接和交叉引用
开发指南
项目结构
vite-plugin-zip-pack/
├── src/ # 源代码
│ ├── index.ts # 插件入口
│ ├── pack.ts # 打包逻辑
│ ├── zip.ts # ZIP 压缩处理
│ └── utils.ts # 工具函数
├── tests/ # 测试文件
├── docs/ # 文档
└── dist/ # 构建输出构建项目
bash
npm run build开发流程
- 修改源代码
- 运行测试确保功能正常
- 更新相关文档
- 提交代码
行为准则
- 保持友好和尊重
- 接受建设性的批评
- 关注对项目最有利的事情
- 对其他社区成员表示同理心
许可证
通过贡献代码，你同意你的贡献将在 MIT 许可证 下发布。
获取帮助
如果你在贡献过程中遇到问题：
- 查看 常见问题
- 在 GitHub Issues 提问
- 查看现有代码和文档
再次感谢你的贡献！🎉