搜索

[22569] 2014-04-16_如何参与一个GitHub开源项目？

文档创建者：s7ckTeam
浏览次数：4
最后更新：2025-01-18
2014-04-16_如何参与一个GitHub开源项目？ 如 何 参 与 一 个 G i t H u b 开 源 项 目 ？ L i n u x 中 国   2 0 1 4 - 0 4 - 1 6 本 文 是 G i t h u b 官 方 给 出 的 参 与 G i t h u b 上 开 源 项 目 的 一 些 指 导 ， 对 希 望 加 入 开 源 社 区 的 开 发 者 是 一 个 不 错 的 参 考 。 最 近 一 年 开 源 项 目 特 别 的 热 ， 很 多 技 术 大 会 或 论 坛 都 以 开 源 项 目 作 为 主 题 进 行 探 讨 ， 可 见 这 是 一 种 趋 势 。 而 G i t h u b 作 为 开 源 项 目 的 著 名 托 管 地 ， 可 谓 无 人 不 知 ， 越 来 越 多 的 个 人 和 公 司 纷 纷 加 入 到 G i t h u b 的 大 家 族 里 来 ， 为 开 源 尽 一 份 绵 薄 之 力 。 对 于 个 人 来 讲 ， 你 把 自 己 的 项 目 托 管 到 G i t h u b 上 并 不 表 示 你 参 与 了 G i t h u b 开 源 项 目 ， 只 能 说 你 开 源 了 自 己 的 项 目 ， 可 以 任 别 人 自 由 下 载 。 那 么 该 如 何 参 与 G i t h u b 的 开 源 项 目 呢 ？ 相 信 很 多 人 都 有 这 方 面 的 疑 问 ， 网 上 也 有 一 些 参 差 不 齐 的 教 程 教 大 家 如 何 “ P u l l   R e q u e s t ” 、 如 何 “ C o m m i t ” 等 等 。 但 这 些 教 程 往 往 不 够 全 面 或 不 够 完 全 正 确 ， 搞 不 好 可 能 让 你 陷 入 一 个 误 区 。 鉴 于 此 ， 前 几 天 G i t h u b 官 方 团 队 写 了 一 篇 很 棒 的 文 章   C o n t r i b u t i n g   t o   O p e n   S o u r c e   o n   G i t H u b ， 专 业 指 导 大 家 如 何 参 与 G i t h u b 的 开 源 项 目 。   下 面 是   原 文 的 翻 译 。 参 与 开 源 项 目 的 最 佳 办 法 就 是 加 入 到 你 正 在 使 用 的 已 有 项 目 上 来 。 G i t h u b 上 有 5 0 0 多 万 开 源 项 目 ， 涉 及 到 各 个 领 域 的 技 术 ， 像   r e c i p e s , H T M L / C S S ,   R u b y ,   A s t r o p h y s i c s 等 等 。 该 指 南 将 涵 盖 你 在 一 个 典 型 的 项 目 中 可 能 出 现 的 事 情 以 及 如 何 为 开 源 项 目 作 出 贡 献 。 找 项 目 我 们 推 荐 你 从 已 正 在 使 用 的 或 感 兴 趣 的 项 目 开 始 。 这 里 有 几 个 很 棒 的 地 方 供 你 参 考 ： G i t H u b   E x p l o r e ： 受 欢 迎 和 热 门 的 项 目 。 G i t H u b   S t a r s ： 被 其 他 人 s t a r 过 的 项 目 （ 指 的 是 你 自 己 库 的 项 目 ） 。 G i t H u b   S h o w c a s e s ： 一 个 能 搜 索 相 关 库 的 方 法 。 L a y e r V a u l t   N e w s ： 前 端 和 设 计 相 关 的 项 目 。 一 个 典 型 的 项 目 下 面 是 一 些 你 在 G i t h u b 开 源 项 目 中 可 能 遇 到 的 因 素 。 T h e   C o m m u n i t y （ 社 区 ） 项 目 通 常 会 有 一 个 社 区 维 护 ， 由 不 同 角 色 （ 正 规 或 非 正 规 ） 的 其 他 用 户 组 成 ： 所 有 者 （ O w n e r ） ： 即 创 建 该 项 目 且 在 他 们 G i t h u b 账 户 上 有 该 项 目 的 用 户 或 组 织 。
维 护 者 和 协 作 者 （ M a i n t a i n e r s   a n d   C o l l a b o r a t o r s ） ：   致 力 于 一 个 项 目 并 促 进 该 项 目 发 展 的 用 户 。 通 常 所 有 者 和 维 护 者 是 同 一 个 用 户 或 组 织 ， 他 们 对 项 目 库 都 有 写 的 权 限 。 贡 献 者 （ C o n t r i b u t o r s ） ： 每 一 个 对 该 项 目 发 出 过 p u l l   r e q u e s t 并 合 并 到 项 目 中 的 用 户 都 是 贡 献 者 。 社 区 成 员 （ C o m m u n i t y   M e m b e r s ） ： 即 那 些 经 常 使 用 且 非 常 关 心 该 项 目 的 用 户 ， 他 们 在 讨 论 功 能 特 征 和 p u l l   r e q u e s t 上 非 常 活 跃 。 T h e   D o c s （ 文 档 ） 一 般 项 目 中 都 有 的 文 件 。 R e a d m e ： 几 乎 所 有 的 G i t h u b 项 目 都 包 含 一 个 R E A D M E . m d 文 件 。 r e a d m e 提 供 了 该 项 目 的 一 个 概 览 及 关 于 如 何 使 用 、 构 建 甚 至 如 何 贡 献 于 一 个 项 目 的 相 关 细 节 。 C o n t r i b u t i n g ： 项 目 和 项 目 维 护 者 不 同 ， 所 以 每 个 项 目 所 期 望 的 作 贡 献 的 最 佳 方 法 也 会 有 所 不 同 。 一 定 要 注 意 一 个 标 注 为 C O N T R I B U T I N G 的 文 档 ， C o n t r i b u t i n g 文 档 详 细 描 述 了 一 个 项 目 的 维 护 者 希 望 看 到 贡 献 的 补 丁 或 功 能 应 该 符 合 怎 样 的 规 格 。 这 可 能 包 含 要 写 什 么 测 试 ， 代 码 语 法 规 范 或 补 丁 集 中 的 区 域 。 L i c e n s e ： 一 个 L I C E N S E 文 件 当 然 就 是 该 项 目 的 许 可 证 了 。 一 个 开 源 项 目 的 l i c e n s e 会 告 诉 用 户 他 们 能 做 和 不 能 做 的 （ 例 如 使 用 、 修 改 、 重 新 发 布 ） ， 及 告 诉 贡 献 者 他 们 允 许 其 他 人 做 的 。 有 许 多 的 办 法 对 开 源 项 目 加 上 许 可 证 ， 你 可 以 在   c h o o s e a l i c e n s e . c o m 读 到 更 多 的 关 于 每 个 许 可 证 的 含 义 。 D o c u m e n t a t i o n   a n d   W i k i s ： 许 多 大 型 项 目 有 的 不 只 有 一 个 r e a d m e 来 指 导 人 么 如 何 使 用 他 们 的 项 目 。 在 这 种 情 况 下 你 通 常 能 够 发 现 一 个 指 向 库 中 名 为 “ d o c s ” 的 另 一 个 文 件 或 文 件 夹 的 链 接 。 另 外 ， 该 库 也 可 能 使 用 G i t h u b   w i k i 来 代 替 文 档 。 贡 献 于 一 个 项 目 既 然 你 已 经 找 到 了 理 解 该 项 目 的 相 关 资 料 ， 下 面 你 就 可 以 采 取 一 些 行 动 了 。 建 立 一 个 话 题 如 果 你 发 现 了 你 正 在 使 用 的 项 目 中 的 一 个 b u g （ 但 是 你 不 知 道 怎 么 去 修 复 它 ） ， 或 对 文 档 有 不 解 或 对 项 目 有 疑 问   —   那 么 创 建 一 个 话 题 吧 ！ 这 非 常 容 易 且 一 般 你 不 管 创 建 什 么 话 题 ， 你 都 可 能 不 是 唯 一 一 个 出 现 该 问 题 的 人 ， 所 以 其 他 人 可 能 会 发 现 你 的 话 题 很 有 帮 助 。 关 于 更 多 的 话 题 介 绍 ， 请 查 看 我 们 的   I s s u e s   g u i d e 。 话 题 专 业 提 示
在 建 话 题 之 前 检 查 已 有 的 话 题 ： 话 题 重 复 对 双 方 都 无 利 ， 所 以 搜 索 整 个 正 开 放 和 已 关 闭 的 话 题 以 检 查 你 遇 到 的 问 题 是 否 已 经 有 人 解 决 了 。 务 必 对 自 己 的 问 题 有 清 晰 的 认 识 ： 期 望 的 结 果 是 什 么 ？ 然 而 却 发 生 了 什 么 ？   详 细 描 述 其 他 人 如 何 重 现 该 问 题 。 在 像   J S F i d d l e 或   C o d e P e n 类 似 的 平 台 上 重 现 该 问 题 并 给 出 问 题 d e m o 的 链 接 。 包 含 一 些 系 统 相 关 的 细 节 ， 比 如 用 的 什 么 浏 览 器 、 库 或 操 作 系 统 及 版 本 号 。 在 你 的 话 题 或 在   G i s t 里 贴 出 你 的 错 误 输 出 或 日 志 。 如 果 在 话 题 里 贴 出 来 ， 请 用 三 个 反 引 号 ` ` `   包 围 起 来 使 得 能 够 良 好 的 呈 现 给 大 家 。 P u l l   R e q u e s t 如 果 你 能 够 修 复 b u g 或 自 己 添 加 功 能   —   太 棒 了 ， 请 发 一 个 p u l l   r e q u e s t 吧 ！ 确 保 你 已 经 读 过 任 何 关 于 c o n t r i b u t i n g 的 文 档 ， 且 需 要 理 解 l i c e n s e 以 及 已 经 签 过 C L A （ 如 果 需 要 的 话 ） 。 一 旦 你 提 交 了 一 个 p u l l   r e q u e s t ， 维 护 者 就 会 将 你 的 分 支 与 已 有 的 分 支 作 比 较 来 决 定 是 否 要 合 并 （ 即 p u l l i n ） 你 作 的 改 动 。 P u l l   R e q u e s t 专 业 提 示 F o r k   该 项 目 库 及 将 它 c l o n e 到 本 地 。 通 过 添 加 为 远 程 的 方 式 在 本 地 连 接 到 原 来 的 ‘ u p s t r e a m ’ 库 。 经 常 从 ‘ u p s t r e a m ’ 库 p u l l   i n 改 动 以 保 持 库 最 新 ， 这 样 当 你 提 交 p u l l   r e q u e s t 时 ， 就 不 大 可 能 发 生 合 并 冲 突 了 。 点   这 里 看 更 多 的 指 导 细 节 。 为 你 的 编 辑 单 独 建 立 一 个 分 支   。 务 必 清 楚 所 出 现 的 问 题 以 及 如 何 重 现 该 问 题 或 为 什 么 你 的 功 能 有 帮 助 。 然 后 同 样 的 要 清 楚 做 一 些 改 变 有 哪 些 步 骤 。 最 好 测 试 一 下 。 在 任 何 已 有 的 测 试 （ 如 果 存 在 ） 上 运 行 你 所 做 的 改 动 并 在 必 要 时 创 建 新 的 测 试 。 不 管 测 试 存 不 存 在 ， 都 要 确 保 你 的 改 动 不 会 破 坏 已 有 的 项 目 。 如 果 你 的 改 动 包 含 了 H T M L / C S S 方 面 的 不 同 ， 那 么 请 包 含 改 动 前 和 改 动 后 的 截 图 。 将 你 的 图 片 拖 放 到 你 p u l l   r e q u e s t 的 正 文 里 。 尽 你 所 能 的 在 项 目 的 风 格 上 多 做 努 力 。 这 可 能 意 味 着 使 用 不 同 于 你 自 己 G i t h u b 库 中 采 用 的 缩 进 ， 分 号 或 注 释 ， 但 是 这 让 维 护 者 更 容 易 合 并 ， 也 让 其 他 人 更 容 易 理 解 和 以 后 的 维 护 。 开 放 的 P u l l   R e q u e s t s 一 旦 你 打 开 一 个 p u l l   r e q u e s t ， 就 会 有 一 个 讨 论 ， 围 绕 你 提 出 的 改 变 作 出 探 讨 。 其 他 的 贡 献 者 和 用 户 可 能 会 参 与 进 来 ， 但 最 终 由 维 护 者 做 决 定 。 你 可 能 会 被 要 求 对 你 的 p u l l   r e q u e s t 做 一 些 改 变 ， 如 果 这 样 ， 请 给 你 的 分 支 添 加 更 多 的 c o m m i t 并 p u s h 它 们   —   它 们 将 自 动 的 加 入 到 已 有 的 p u l l   r e q u e s t 里 。 如 果 你 的 p u l l   r e q u e s t 被 合 并 了 — — 太 好 了 ！ 如 果 没 被 合 并 的 话 ， 也 没 什 么 大 不 了 的 ， 也 许 这 不 是 项 目 维 护 者 所 期 望 看 到 的 改 动 ， 亦 或 者 他 们 已 经 致 力 于 该 b u g 或 功 能 。 这 种 情 况 有 可 能 发 生 ， 所 以 我 们 的 建 议 是 ： 对 收 到 的 结 果 做 出 反 馈 ， 进 一 步 努 力 然 后 再 次 p u l l   r e q u e s t 出 去 —   或 者 创 建 你 自 己 的 开 源 项 目 。
V I A   G i t H u b   &   C S D N   博 客 本 文 地 址 ： h t t p : / / l i n u x . c n / a r t i c l e - 2 8 4 9 - 1 . h t m l 阅 读 原 文
回复

举报

高级模式
B Color Image Link Quote Code Smilies
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

使用Markdown编辑器编辑 使用富文本编辑器编辑

Archiver| 手机版| 小黑屋|
Powered by Discuz! X3.4 Copyright © 2001-2020, Tencent Cloud. 商业源码建议获取授权，如侵犯您的权益，请联系客服处理