贡献指南

感谢你考虑为本知识库做出贡献！

贡献方式

内容贡献

欢迎贡献以下内容：

• 新增章节和文章
• 修正错误和错别字
• 改进文档结构
• 添加示例代码
• 翻译内容

问题反馈

发现问题时：

1. 检查是否已有相关问题
2. 创建详细的 Issue 描述
3. 提供复现步骤（如适用）

功能建议

欢迎提出改进建议：

• 新功能想法
• 用户体验优化
• 性能改进建议

贡献流程

Fork 工作流

# 1. Fork 本仓库到你的账户

# 2. 克隆到本地
git clone https://github.com/your-username/obsidian-learning.git

# 3. 创建分支
git checkout -b feature/your-feature

# 4. 进行更改
# 编辑文件...

# 5. 提交更改
git add .
git commit -m "feat: 添加新章节"

# 6. 推送到 Fork
git push origin feature/your-feature

# 7. 创建 Pull Request

提交信息规范

提交类型:
  feat: 新功能/新内容
  fix: 修复问题
  docs: 文档更新
  style: 格式调整
  refactor: 重构优化
  chore: 维护任务

示例:
  feat: 添加 AI 辅助功能章节
  fix: 修正安装步骤描述
  docs: 更新 API 参考文档

文档规范

文件命名

命名规则:
  - 使用小写字母
  - 使用连字符分隔
  - 使用有意义的名称

示例:
  ✓ getting-started.md
  ✓ plugin-development.md
  ✗ Getting Started.md
  ✗ 新建文档.md

Frontmatter

每个文档应包含 frontmatter：

---
title: 文档标题
description: 简短描述（用于 SEO 和预览）
---

标题结构

# 主标题（H1）

简介段落...

## 二级标题

### 三级标题

#### 四级标题（尽量避免更深层级）

代码块

指定语言以启用语法高亮：

```javascript
console.log('Hello');
```

```bash
npm install obsidian
```

表格

| 列1 | 列2 | 列3 |
|-----|-----|-----|
| 内容 | 内容 | 内容 |

链接

# 内部链接
[链接文本](/path/to/page)

# 外部链接
[链接文本](https://example.com)

内容指南

写作风格

• 使用简洁清晰的语言
• 避免冗长的句子
• 使用主动语态
• 提供具体示例

内容结构

# 标题

简短介绍（1-2 段）

## 主要内容

### 子主题

## 示例

## 注意事项

## 相关链接

## 下一步

示例代码

• 确保代码可运行
• 添加必要注释
• 说明运行环境

审核流程

PR 审核

1. 自动检查（格式、链接）
2. 内容审核
3. 建议修改（如需要）
4. 合并到主分支

审核标准

• 内容准确性
• 格式规范性
• 链接有效性
• 无拼写错误

本地预览

# 安装依赖
npm install

# 启动开发服务器
npm run docs:dev

# 构建生产版本
npm run docs:build

获取帮助

• 创建 Issue 提问
• 在 PR 中 @ 维护者
• 查看现有文档参考

行为准则

• 尊重所有贡献者
• 接受建设性批评
• 关注对社区有益的内容
• 保持友好和专业

---

再次感谢你的贡献！ 🎉