Contribution Guide

Thank you for your interest in the Kecare project!

Development Environment

Node.js
Bun (Recommended)

Project Structure

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

Local Development

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

# 安装依赖
bun install

# 运行生成器
bun run gen

# 启动开发服务器
bun run dev

# 运行测试
bun run test

Code Standards

The project uses oxlint and oxfmt for code linting and formatting:

Please ensure the code passes the check before submitting.

Commit Specification

Commit message format:

<type>: <description>

Type:

feat: New feature
fix: Bug fix
docs: Documentation update
refactor: Code refactoring
test: Test related

Example:

feat: Add article pinning feature
fix: Fix translation cache invalidation issue

Contribution Process

Fork the project
Create a branch: git checkout -b feat/your-feature
Make changes and commit them
Push the branch: git push origin feat/your-feature
Submit a Pull Request

Directory Structure Conventions

packages/kecare/types.ts - Core type definitions
projects/generator/ - Generator logic
projects/theme/.kecare/articles/ - Documentation articles

Add new types in types.ts.

Testing

Test files are located in the projects/test/ directory:

bun run test

Please add corresponding test cases for new features