贡献工作流程

相关源文件

• .travis.yml
• README.md

本页面记录了向 free-programming-books-zh_CN 仓库贡献的详细步骤。它涵盖了如何提交新资源、更新现有链接以及有效地参与项目的维护。有关资源质量指南的信息，请参阅 维护资源质量。

贡献流程概述

free-programming-books-zh_CN 仓库是一个由社区维护的中文免费编程资源集合。贡献主要通过 GitHub 的 Pull Request 机制进行，该机制允许在更改合并到主集合之前进行适当的审查。

贡献工作流程图

来源： README.md16-24

准备步骤

在贡献到仓库之前，您需要设置好您的环境以进行更改。

1. Fork 仓库

通过在 GitHub 上 fork（复刻）仓库来创建您自己的副本。

来源： README.md20

2. 克隆您的 Fork

将您的 Fork 克隆到本地机器以进行更改

git clone https://github.com/YOUR-USERNAME/free-programming-books-zh_CN.git
cd free-programming-books-zh_CN

3. 设置上游远程仓库（可选）

以保持您的 Fork 与主仓库同步

git remote add upstream https://github.com/justjavac/free-programming-books-zh_CN.git

来源： README.md20-22

进行更改

该仓库主要由一个 README.md 文件组成，其中包含所有链接和分类。大多数贡献涉及在此文件中添加新资源或更新现有链接。

仓库结构概述

来源： README.md32-92

贡献类型

1. 添加新资源

   • 在 README.md 中找到合适的分类
   • 按照现有格式添加您的资源
   • 如果可能，在分类中保持字母顺序

2. 修复/标记失效链接

   • 如果您发现失效链接，请在链接后添加 :worried: 表情符号
   • 示例： * [资源名称](http://broken-link.com) :worried:

3. 创建新分类

   • 对于大量的添加，请考虑是否需要新的分类
   • 遵循现有的分类结构

来源： README.md22

格式指南

资源应使用以下 Markdown 格式添加

* <FileRef file-url="https://github.com/justjavac/free-programming-books-zh_CN/blob/2ca0d17c/Resource Title" undefined  file-path="Resource Title">Hii</FileRef>

或，对于带有描述的资源

* <FileRef file-url="https://github.com/justjavac/free-programming-books-zh_CN/blob/2ca0d17c/Resource Title" undefined  file-path="Resource Title">Hii</FileRef> (optional brief description)

对于失效链接

* <FileRef file-url="https://github.com/justjavac/free-programming-books-zh_CN/blob/2ca0d17c/Resource Title" undefined  file-path="Resource Title">Hii</FileRef> :worried:

元素	格式
列表标记	星号（*）
资源标题	[标题]（方括号）
URL	括号（http://example.com）
失效链接指示符	链接后跟 :worried: 表情符号

来源： README.md22 README.md104-110 (示例)

提交您的贡献

做出更改后，即可提交 Pull Request。

1. 提交您的更改

git add README.md
git commit -m "Add resource: [brief description of what you added]"

2. 推送至您的 Fork

git push origin master

3. 创建 Pull Request

导航到 GitHub 上的您的 Fork，然后点击“New Pull Request”（新建 Pull Request）。提供清晰的标题和更改描述。

来源： README.md20 .travis.yml1-4

4. PR 审查流程

提交 PR 后

1. Travis CI 将自动检查您的提交
2. 仓库维护者将审查您的贡献
3. 维护者可能会要求进行更改或澄清
4. 批准后，您的 PR 将被合并到主仓库

来源： README.md24

拉取请求指南

为确保您的贡献得到有效审查和合并

1. 保持 PR 的专注性

   • 为不相关的更改提交单独的 PR
   • 例如：不要将添加新的 Python 资源与修复 JavaScript 链接合并

2. 提供背景信息

   • 在 PR 描述中，解释该资源为何有价值
   • 提及是否替换了失效资源

3. 检查重复项

   • 验证资源是否已在收藏中
   • 搜索仓库和现有的 PR

您的贡献之后

您的贡献被合并后

1. 您的名字将由 GitHub 自动添加到贡献者列表中
2. 您可以将您的 Fork 与上游仓库同步以保持最新

贡献者页面显示所有成功为项目做出贡献的人员： https://github.com/justjavac/free-programming-books-zh_CN/graphs/contributors

来源： README.md24

处理特殊情况

报告失效链接

当您发现失效链接但没有替换项时

1. 在链接后添加 :worried: 表情符号
2. 提交仅包含此更改的 PR
3. 这会提醒维护者和其他贡献者该链接需要关注

* [Resource Name](http://example.com) :worried:

来源： README.md22

更新您的 PR

如果维护者要求进行更改

1. 在本地进行所需的更改
2. 提交并推送到您的 Fork
3. PR 将自动更新
4. 在 PR 上评论以通知维护者您的更新

贡献影响

每一次贡献都改进了仓库，并帮助中文开发者社区获取优质学习资源。最常见的贡献包括：

贡献类型	影响
添加新资源	用新内容扩展收藏
标记失效链接	维护现有内容的质量
修复失效链接	确保资源可访问性
整理内容	提高导航和可发现性

来源： README.md6 README.md16-18