贡献指南

感谢您对 DevPedia Hub 的关注！我们欢迎所有形式的贡献，让这个知识库变得更加完善和有用。

🤝 贡献方式

📝 内容贡献

• 新增文章: 添加新的技术文档或教程
• 完善内容: 改进现有文章的内容质量
• 修正错误: 修复文档中的错误或过时信息
• 添加示例: 为技术概念添加实用代码示例

🔧 技术贡献

• 网站优化: 改进网站功能和用户体验
• 主题定制: 优化页面设计和布局
• 性能提升: 提升网站加载速度和响应性能
• 工具开发: 开发辅助工具和脚本

🐛 问题反馈

• Bug报告: 发现并报告网站或内容问题
• 功能建议: 提出新功能或改进建议
• 使用反馈: 分享使用体验和改进意见

📋 贡献流程

1. 准备工作

Fork 仓库

# 1. Fork DevPedia Hub 仓库到您的GitHub账号
# 2. 克隆您的Fork仓库
git clone https://github.com/YOUR_USERNAME/devpedia-hub.git
cd devpedia-hub

# 3. 添加上游仓库
git remote add upstream https://github.com/ORIGINAL_OWNER/devpedia-hub.git

本地环境设置

# 安装依赖
npm install

# 启动开发服务器
npm run dev

# 构建项目
npm run build

2. 内容创建

文章结构规范

# 文章标题

简短的文章介绍，说明本文将涵盖的主要内容。

## 目录
- [基础概念](#基础概念)
- [实际应用](#实际应用)
- [最佳实践](#最佳实践)

## 基础概念

### 子标题
内容描述...

## 代码示例

\```javascript
// 代码示例
function example() {
  console.log('Hello DevPedia!');
}
\```

## 实际应用

### 使用场景
实际应用场景描述...

## 最佳实践

### 推荐做法
- 做法一：描述
- 做法二：描述

## 相关资源
- [相关文档链接](./related-doc.md)
- [外部资源](https://example.com)

文件命名规范

• 使用小写字母和连字符: react-hooks.md
• 体现内容主题: spring-boot-security.md
• 避免特殊字符: 不使用空格、中文、特殊符号

目录结构规范

新增内容位置参考：
frontend/javascript/新特性.md
backend/java/框架使用.md
database/mysql/性能优化.md

3. 内容质量标准

技术准确性

• ✅ 信息准确，引用可靠来源
• ✅ 代码可运行，经过测试验证
• ✅ 版本信息明确，避免过时内容
• ✅ 概念解释清晰，逻辑连贯

写作质量

• ✅ 语言简洁明了，避免冗余
• ✅ 结构清晰，使用合适的标题层级
• ✅ 代码格式规范，添加必要注释
• ✅ 提供实用示例，便于理解

用户体验

• ✅ 考虑读者技术水平，提供背景介绍
• ✅ 添加相关链接，方便扩展阅读
• ✅ 使用图表说明复杂概念
• ✅ 提供可操作的步骤指南

4. 提交规范

Git 提交信息

# 功能类型: 简短描述

feat: 添加Vue3 Composition API教程
fix: 修正React Hooks示例错误
docs: 更新Spring Boot配置说明
style: 改进代码格式

Pull Request 规范

## 变更说明
- 添加了什么内容
- 修改了哪些文件
- 解决了什么问题

## 相关Issue
- Fixes #123
- 关联 #456

## 测试验证
- [ ] 本地构建通过
- [ ] 链接检查无误
- [ ] 代码示例测试通过

## 截图预览
如有UI变更，请添加截图

5. 审核流程

自查清单

• [ ] 内容准确性检查
• [ ] 拼写和语法检查
• [ ] 代码格式检查
• [ ] 链接有效性检查
• [ ] 移动端显示检查

社区审核

1. 提交PR: 提交Pull Request
2. 代码审查: 社区成员review代码和内容
3. 反馈修改: 根据反馈进行修改
4. 合并发布: 审核通过后合并到主分支

🎨 写作风格指南

语言风格

• 简洁明了: 避免复杂长句，使用简单词汇
• 技术准确: 使用准确的技术术语
• 友好亲和: 使用 "您" 而不是 "你"，保持专业友好
• 逻辑清晰: 按照逻辑顺序组织内容

格式规范

• 标题层级: 合理使用 H1-H6 标题
• 列表使用: 适当使用有序和无序列表
• 强调标记: 使用 粗体 和 斜体 强调重点
• 代码标记: 使用 行内代码 和代码块

技术文档特色

• 实用导向: 注重实际应用和解决问题
• 示例丰富: 提供充分的代码示例
• 版本明确: 明确技术版本和适用范围
• 最佳实践: 分享业界最佳实践

🏆 贡献者权益

认可方式

• 贡献者列表: 在项目中展示贡献者信息
• GitHub统计: 贡献记录在GitHub个人档案
• 社区声誉: 在开发者社区建立技术声誉

成长机会

• 技术提升: 通过写作梳理和深化技术理解
• 经验分享: 与其他开发者交流学习
• 影响力扩大: 帮助更多开发者学习成长

📞 联系我们

沟通渠道

• GitHub Issues: 用于问题报告和功能建议
• GitHub Discussions: 用于讨论和交流
• 邮件联系: [email@example.com]

获取帮助

如果您在贡献过程中遇到任何问题：

1. 查看现有文档: 参考已有的优质文章格式
2. 搜索相关Issue: 查看是否有类似问题的讨论
3. 提出问题: 在GitHub Issues中提出具体问题
4. 参与讨论: 在GitHub Discussions中参与社区讨论

🌟 特别感谢

感谢每一位为 DevPedia Hub 做出贡献的开发者！您的每一份贡献都让这个知识库变得更加完善，帮助了无数学习者和开发者。

让我们一起构建更好的开发者知识社区！