CodingTrain网站归档项目贡献指南详解

CodingTrain网站归档项目贡献指南详解

website-archive Archive of the Coding Train website (first version) 项目地址: https://gitcode.com/gh_mirrors/we/website-archive

前言

CodingTrain网站归档项目是一个汇集了大量编程挑战、教程和课程内容的宝贵资源库。作为技术社区的一员，你可能希望将自己的创意实现或改进版本分享到这个项目中。本文将详细介绍如何规范地提交你的贡献，确保你的作品能够被正确展示并与原始内容关联。

准备工作

在开始之前，请确保你已经完成了以下准备工作：

1. 基于CodingTrain的某个编程挑战或教程创建了自己的实现
2. 将你的代码托管在可公开访问的平台上
3. 准备好了一个可运行的演示链接（如果适用）

贡献流程详解

第一步：定位对应文件

项目内容按照不同类型组织在以下目录结构中：

• CodingChallenges：编程挑战集合
• Courses：课程内容集合
• Tutorials：教程集合
• GuestTutorials：嘉宾教程集合

每个目录下都有对应的Markdown文件，记录了原始内容的信息。你需要找到与你作品对应的原始内容文件。

实用技巧：

• 使用视频编号（如"Tutorial #1.2"）可以快速定位子目录
• 如果找不到对应文件，你可以按照规范创建一个新文件

第二步：添加贡献信息

找到对应文件后，你需要编辑其YAML前端内容（即文件开头两个---之间的部分）。以下是详细的操作步骤：

1. 查找或创建contributions字段
2. 按照规范格式添加你的贡献信息
3. 保存修改

YAML字段说明：

• title（必需）：你的作品标题
• author.name（必需）：你的名字
• author.url（推荐）：你的个人主页或作品集链接
• url（推荐）：可运行的演示链接
• source（推荐）：源代码仓库链接
• video_id（可选）：如果你的作品是视频，提供视频ID

示例格式：

contributions:
  - title: "我的创意实现"
    author:
      name: "张三"
      url: "https://example.com"
    url: "https://example.com/demo"
    source: "https://example.com/source"

特殊情况处理

如果你的作品无法直接在浏览器中运行，而是以视频形式展示：

1. 不要直接使用YouTube视频链接
2. 提取视频URL中的ID（如https://youtu.be/abc123中的abc123）
3. 使用video_id字段而非url字段

第三步：提交变更

完成编辑后，你需要提交变更请求。以下是注意事项：

1. 为你的变更提供清晰的标题和描述
2. 在描述中包含演示链接或截图/视频
3. 说明你的作品与原始内容的关联性
4. 表明你是否希望你的作品被分享到社交媒体

最佳实践建议

1. 标题规范：使用简洁明了的标题，准确描述你的作品特点
2. 演示质量：确保提供的演示链接稳定可用
3. 代码质量：保持代码整洁并有适当注释
4. 原创性：确保你的作品有足够的创新点，而非简单复制
5. 文档完整：在源代码中包含README说明文件

常见问题解答

Q：我的作品必须完全基于原始内容吗？ A：不，你可以进行创新和扩展，但需要保持与原始内容的明显关联。

Q：我可以提交多个版本的贡献吗？ A：可以，只要每个版本都有独特的价值，你可以提交多个贡献。

Q：我的贡献会被审核吗？ A：是的，项目维护者会审核每个提交，确保内容质量和相关性。

结语

通过遵循本指南，你可以将你的创意作品分享给更广大的编程社区。这不仅是对你技能的展示，也是对开源社区的宝贵贡献。期待看到你的精彩作品！

website-archive Archive of the Coding Train website (first version) 项目地址: https://gitcode.com/gh_mirrors/we/website-archive