Skip to content

Latest commit

 

History

History
235 lines (160 loc) · 4.68 KB

File metadata and controls

235 lines (160 loc) · 4.68 KB

贡献指南

感谢您对 GameDevMind 项目的关注!我们欢迎所有形式的贡献。

📋 目录

📜 行为准则

请保持友好和尊重,我们致力于为每个人提供开放和欢迎的环境。

🤝 如何贡献

报告问题

如果您发现了问题或有改进建议,请:

  1. 检查 Issues 中是否已有相关问题
  2. 如果没有,请创建新的 Issue,并:
    • 使用清晰的标题
    • 详细描述问题或建议
    • 如果可能,提供复现步骤或示例

贡献内容

  1. Fork 本仓库
  2. 创建 您的特性分支 (git checkout -b feature/AmazingFeature)
  3. 提交 您的更改 (git commit -m 'Add some AmazingFeature')
  4. 推送 到分支 (git push origin feature/AmazingFeature)
  5. 开启 一个 Pull Request

📝 文档编写规范

文件命名

  • 使用中文命名,格式:编号.标题.md
  • 例如:1.1.1.编程语言基础概念.md
  • 编号格式:主分类.子分类.具体主题.md

Markdown 格式

标题

  • 使用 Markdown 语法,不使用 HTML 标签
  • 一级标题:# 标题
  • 二级标题:## 标题
  • 三级标题:### 标题

错误示例

<h2 align="center">标题</h2>

正确示例

## 标题

图片

  • 使用相对路径
  • 格式:![图片描述](../../exports/图片名.png)
  • 确保图片存在于 exports/ 目录

链接

  • 内部链接使用相对路径
  • 外部链接使用完整 URL
  • 格式:[链接文本](路径或URL)

代码块

  • 指定语言类型
  • 格式:
    ```语言
    代码内容
    
    

列表

  • 有序列表使用数字:1. 项目
  • 无序列表使用 -*- 项目

文档结构

每个文档应包含以下部分:

## 标题

<p>
简介或说明
</p>

**关键词:**<br/>
*关键词1, 关键词2, 关键词3*

## 图谱
![图片加载中...](../../exports/图片名.png)

## 子主题
(如果有子主题,列出链接)

## 更多资料
(可选,包含参考资料、视频、文档等)

内容要求

  1. 准确性:确保内容准确、最新
  2. 完整性:提供足够的信息,但保持简洁
  3. 可读性:使用清晰的语言,适当使用列表和表格
  4. 链接:提供相关资源的链接

📤 提交规范

Commit Message 格式

使用以下格式:

<type>(<scope>): <subject>

<body>

<footer>

Type 类型

  • feat: 新功能
  • fix: 修复问题
  • docs: 文档更新
  • style: 格式调整(不影响代码)
  • refactor: 重构
  • perf: 性能优化
  • test: 测试相关
  • chore: 构建过程或辅助工具的变动

示例

docs(基础能力): 更新编程语言章节

添加了 Rust 语言相关内容
更新了 C++ 版本说明

Closes #123

提交频率

  • 每个逻辑更改提交一次
  • 保持提交信息清晰
  • 避免提交过多小改动

🔄 Pull Request 流程

创建 PR 前

  1. ✅ 确保代码/文档符合规范
  2. ✅ 确保所有链接有效
  3. ✅ 确保图片路径正确
  4. ✅ 更新相关文档(如需要)
  5. ✅ 测试您的更改

PR 标题格式

<type>: <简短描述>

示例:

  • docs: 添加设计模式章节
  • fix: 修复图片链接错误
  • feat: 添加新工具脚本

PR 描述

请包含:

  1. 变更说明:简要描述您的更改
  2. 相关 Issue:如果有,链接相关 Issue
  3. 检查清单
    • 文档格式符合规范
    • 所有链接有效
    • 图片路径正确
    • 已更新相关文档

审查流程

  1. 提交 PR 后,维护者会进行审查
  2. 可能需要修改,请根据反馈进行调整
  3. 审查通过后,PR 会被合并

🛠️ 开发环境设置

必需工具

  • Git
  • Markdown 编辑器(推荐 VS Code)
  • (可选)Node.js(用于运行工具脚本)

本地测试

  1. Fork 并克隆仓库
  2. 检查文档格式
  3. 验证链接有效性
  4. 预览更改效果

📚 资源

❓ 问题

如果您有任何问题,请:

  1. 查看 Issues
  2. Discussions 中提问
  3. 加入 QQ 群:242500383

🙏 致谢

感谢所有贡献者的支持!您的贡献让这个项目变得更好。