贡献指南
感谢你对 Bevy 教程的贡献！本指南帮助你了解如何贡献内容。
贡献类型
1. 内容贡献
- 新教程：添加新的教程章节
- 内容改进：改进现有教程内容
- 示例代码：添加或改进代码示例
- 翻译：翻译教程内容
2. 结构改进
- 目录结构：优化教程结构
- 导航改进：改进教程导航
- 格式统一：统一文档格式
3. 错误修复
- 拼写错误：修复拼写和语法错误
- 代码错误：修复代码示例错误
- 链接错误：修复失效链接
贡献流程
1. 选择贡献内容
- 查看 Issues 了解需要的内容
- 或提出新的贡献想法
2. 编写内容
- 遵循现有的文档格式
- 使用中文编写
- 包含代码示例
- 添加必要的说明
3. 提交贡献
- Fork 仓库
- 创建新分支
- 提交更改
- 创建 Pull Request
📋 内容规范
文档格式
- 使用 Markdown 格式
- 遵循现有的文档结构
- 使用清晰的标题层级
- 添加代码示例
代码示例
- 代码应该可以运行
- 添加必要的注释
- 使用有意义的变量名
- 遵循 Rust 代码规范
语言风格
- 使用简体中文
- 语言清晰易懂
- 避免过于复杂的句子
- 使用专业术语时提供解释
📚 教程结构
基本结构
每个教程文档应该包含：
- 标题：清晰的标题
- 概述：简要介绍内容
- 目录：文档目录（如果内容较长）
- 正文：主要内容
- 示例：代码示例
- 总结：要点总结
- 相关链接：相关资源链接
代码块格式
// 使用 rust 代码块
fn example() {
println!("Hello, Bevy!");
}引用代码
使用代码引用格式：
fn example() {
println!("Hello, Bevy!");
}检查清单
提交前请检查：
- 内容准确无误
- 代码示例可以运行
- 格式符合规范
- 没有拼写错误
- 链接有效
- 添加了必要的索引链接
协作
- 尊重其他贡献者
- 提供建设性反馈
- 保持友好的讨论氛围
- 遵循代码审查流程
📧 联系方式
如有问题，可以通过以下方式联系：
- 创建 Issue
- 发送 Pull Request
- 参与讨论
感谢你的贡献！ 🙏
索引：返回主目录