贡献指南

感谢你对 OpenManual 项目的关注！欢迎以各种方式参与贡献。

行为准则

参与本项目即表示你同意遵守贡献者公约，保持友善和尊重的交流态度。

如何贡献

报告 Bug

通过 GitHub Issues 报告问题。请包含：

1. 清晰的标题 — 简要描述问题
2. 复现步骤 — 详细说明如何复现
3. 预期行为 — 你期望发生什么
4. 实际行为 — 实际发生了什么
5. 环境信息 — 操作系统、Node.js 版本等

建议新功能

在 Issue 中描述：

1. 功能描述 — 你希望添加什么功能
2. 使用场景 — 为什么需要这个功能
3. 替代方案 — 你考虑过的其他方案

提交代码

开发环境设置

# 克隆仓库
git clone https://github.com/shenjingnan/openmanual.git
cd openmanual

# 安装依赖
pnpm install

# 开发模式
pnpm run dev

# 构建项目
pnpm run build

# 运行测试
pnpm run test

# 代码检查
pnpm run check

分支策略

• main — 主分支，保持稳定
• feature/* — 新功能分支
• fix/* — Bug 修复分支
• docs/* — 文档更新分支

提交规范

遵循 Conventional Commits：

<type>(<scope>): <description>

类型包括：feat、fix、docs、style、refactor、perf、test、chore

Pull Request 流程

1. Fork 仓库
2. 创建功能分支 (git checkout -b feature/my-feature)
3. 进行更改
4. 确保测试通过 (pnpm run test)
5. 确保代码检查通过 (pnpm run check)
6. 提交更改 (git commit -m "feat: add my feature")
7. 推送分支 (git push origin feature/my-feature)
8. 创建 Pull Request

PR 检查清单

• 代码通过所有测试
• 代码通过 lint 检查
• 代码通过类型检查
• 新功能有对应测试
• 文档已更新（如需要）
• Commit 消息遵循规范

开发命令

许可证

通过贡献代码，你同意你的代码将在 MIT 许可证下发布。