贡献指南

行为准则

本项目遵循行为准则。参与本项目即表示你同意遵守其条款。

如何贡献

报告问题

如果你发现了错误或有问题，请在 GitHub Issues 上提交问题。请包括：

• 问题的清晰描述
• 重现步骤
• 期望行为与实际行为
• 截图（如果适用）
• 环境信息（操作系统、浏览器等）

提交 Pull Request

1. Fork 仓库
2. 创建你的功能分支 (git checkout -b feature/amazing-feature)
3. 提交你的更改 (git commit -m '添加某个功能')
4. 推送到分支 (git push origin feature/amazing-feature)
5. 打开一个 Pull Request

开发设置

# 克隆你的 fork
git clone https://github.com/your-username/docsy-example.git
cd docsy-example

# 安装依赖
npm install

# 启动开发服务器
hugo server -D

文档贡献

编辑现有页面

1. 点击页面右上角的"编辑此页面"链接
2. 在 GitHub 上编辑文件
3. 提交更改

添加新页面

1. 在适当的目录中创建新的 .md 文件
2. 添加 front matter：

---
title: 页面标题
description: 页面描述
weight: 10
---

3. 编写你的内容
4. 提交 Pull Request

内容指南

写作风格

• 使用清晰、简洁的语言
• 使用第二人称（“你可以…"）
• 使用主动语态
• 包含代码示例

Markdown 格式

• 使用标题创建结构
• 使用代码块展示代码
• 使用列表组织信息
• 使用链接引用相关页面

图片

• 将图片放在与内容相同的目录中
• 使用描述性文件名
• 包含 alt 文本

代码贡献

代码风格

• 遵循项目的代码风格
• 编写清晰的提交信息
• 包含测试
• 更新文档

提交信息格式

类型: 简短描述

详细描述（可选）

Fixes #123

类型包括：

• feat: 新功能
• fix: 错误修复
• docs: 文档更新
• style: 格式更改
• refactor: 代码重构
• test: 测试
• chore: 杂项

社区

• 加入我们的 Slack
• 参加 社区会议
• 关注 X 上的 @lxowalle

许可证

通过为该项目做出贡献，你同意你的贡献将根据项目的许可证进行许可。

获取帮助

如果你有任何问题或需要帮助，请：

• 查看文档
• 在 GitHub Discussions 上提问
• 发送邮件到 邮件列表

感谢你的贡献！