贡献指南

感谢你对 Kecare 项目的关注！

开发环境

• Node.js
• Bun（推荐）

项目结构

Kecare/
├── packages/
│   ├── kecare/          # 核心包，类型定义和工具函数
│   └── create-kecare/   # 项目初始化脚手架
├── projects/
│   ├── generator/       # 生成器核心
│   └── theme/           # 示例主题

本地开发

# 克隆项目
git clone https://github.com/Pamperkyumi/kecare.git
cd Kecare

# 安装依赖
bun install

# 运行生成器
bun run gen

# 启动开发服务器
bun run dev

# 运行测试
bun run test

代码规范

项目使用 oxlint 和 oxfmt 进行代码检查和格式化：

提交前请确保代码通过检查。

提交规范

提交信息格式：

<type>: <description>

类型：

• feat: 新功能
• fix: 修复 bug
• docs: 文档更新
• refactor: 代码重构
• test: 测试相关

示例：

• feat: 添加文章置顶功能
• fix: 修复翻译缓存失效问题

贡献流程

1. Fork 项目
2. 创建分支：git checkout -b feat/your-feature
3. 进行修改并提交
4. 推送分支：git push origin feat/your-feature
5. 提交 Pull Request

目录结构约定

• packages/kecare/types.ts - 核心类型定义
• projects/generator/ - 生成器逻辑
• projects/theme/.kecare/articles/ - 文档文章

新增类型请在 types.ts 中添加。

测试

测试文件位于 projects/test/ 目录：

bun run test

新增功能请添加对应测试用例