搜索

[22649] 2014-05-10_实例操作：10个步骤教你将闭源项目转换为开源

文档创建者：s7ckTeam
浏览次数：2
最后更新：2025-01-18
2014-05-10_实例操作：10个步骤教你将闭源项目转换为开源 实 例 操 作 ： 1 0 个 步 骤 教 你 将 闭 源 项 目 转 换 为 开 源 L i n u x 中 国   2 0 1 4 - 0 5 - 1 0 【 编 者 按 】 【 编 者 按 】 D i f i o 是 一 个 基 于 D j a n g o 的 应 用 程 序 ， 它 可 以 跟 踪 你 的 程 序 包 并 在 其 发 生 改 变 时 通 知 你 。 它 提 供 多 种 变 化 分 析 ， 因 此 你 可 以 及 时 判 断 你 何 时 以 及 如 何 升 级 。 之 前 ， D i f i o 是 一 个 闭 源 项 目 ， 但 是 作 者 决 定 把 它 开 源 ， 以 便 能 够 内 部 部 署 以 及 吸 引 更 多 的 社 区 开 发 者 参 与 进 来 。 以 下 是 作 者   A l e x a n d e r   T o d o r o v 撰 写 的 D i f i o 开 源 过 程 中 所 经 历 的 1 0 个 步 骤 ， 编 译 主 要 内 容 如 下 ， 以 供 各 位 参 考 。 1 .   删 除 不 必 要 的 代 码 删 除 不 必 要 的 代 码 任 何 一 个 存 在 了 好 几 年 的 项 目 都 会 积 累 一 些 不 再 使 用 的 代 码 和 功 能 。 删 掉 所 有 可 以 删 除 的 代 码 ， 以 保 持 项 目 的 简 洁 。 开 源 D i f i o 前 大 约 删 除 了 约 2 0 % 的 现 有 代 码 ， 它 们 包 括 ： 未 使 用 的 和 过 时 的 设 置 D j a n g o 的 应 用 静 态 文 件 和 模 板 模 型 类 （ c l a s s ） 旧 的 U R L 弃 用 的 功 能 其 它 P y t h o n 工 具 删 除 需 要 额 外 管 理 的 内 容 和 一 次 性 代 码 。 比 如 ， 我 曾 经 在 一 些 模 板 里 使 用 M a r k d o w n 而 在 另 一 些 地 方 使 用 了 纯 H T M L ， 还 有 一 些 模 板 t a g 只 在 一 两 个 地 方 使 用 。 把 这 些 都 删 除 ， 以 保 证 模 板 间 更 加 一 致 。 硬 编 码 路 径 、 值 、 U R L 等 在 快 速 原 型 中 是 不 可 避 免 的 。 有 时 ， 一 个 封 闭 源 代 码 的 应 用 程 序 及 其 部 署 环 境 的 遗 留 都 需 要 清 理 。 我 已 经 在 需 要 的 地 方 设 置 并 使 用 了 自 定 义 模 板 标 签 。 2 .   创 建 独 立 的 模 块 创 建 独 立 的 模 块 重 新 组 织 文 件 结 构 也 使 得 一 切 更 加 简 洁 和 自 然 。 让 模 块 彼 此 独 立 ， 自 成 一 体 ， 这 样 以 后 分 离 起 来 也 更 为 容 易 。 D i f i o 的 W e b 后 端 部 署 在 O p e n S h i f t ， 它 使 用 了 不 同 的 目 录 布 局 模 板 和 静 态 文 件 。 我 移 动 了 文 件 并 更 新 D j a n g o 的 设 置 ， 以 便 它 们 能 够 正 确 加 载 ， 这 也 让 我 重 新 思 考 静 态 源 文 件 被 送 达 C D N 后 台 的 方 式 。 3 .   分 离 内 部 代 码 和 外 部 代 码 分 离 内 部 代 码 和 外 部 代 码 在 应 用 程 序 中 有 一 些 内 部 代 码 来 为 你 提 供 更 多 信 息 是 很 正 常 的 。 这 些 代 码 如 使 用 情 况 跟 踪 、 其 他 指 标 、 计 费 信 息 等 。 在 基 于 网 络 服 务 的 情 况 下 ， 这 些 功 能 通 常 是 与 核 心 功 能 集 成 在 一 起 的 ， 但 是 它 们 需 要 被 分 离 出 来 。 这 也 是 一 个 决 定 到 底 该 留 下 什 么 的 好 机 会 。 比 如 说 ， D i f i o 就 没 有 传 送 它 的 测 试 用 例 ， 因 为 从 C I 环 境 分 离 它 们 需 要 跟 多 的 工 作 量 。
D i f i o 包 含 五 个 单 独 的 模 块 ： d i f i o /   ( 核 心 用 户 体 验 ) 一 个 配 置 文 件 子 系 统 计 费 模 块 扩 展 管 理 模 块 部 署 相 关 的 模 块 （ 主 要 是 设 置 ） 所 有 这 些 都 进 行 了 适 当 的 分 离 和 相 互 隔 离 ， 以 消 除 内 部 依 赖 关 系 。 目 前 d i f i o / 依 赖 于 几 个 配 置 文 件 的 A P I   ， 它 提 供 了 正 常 的 缺 省 值 ， 这 一 步 也 帮 助 你 从 核 心 用 户 体 验 分 离 一 些 工 作 （ 如 定 制 的 电 子 邮 件 模 板 ） 。 4 .   代 码 重 构 代 码 重 构 重 构 和 测 试 应 该 是 一 个 持 续 的 过 程 。 不 过 ， 到 现 在 为 止 你 可 能 已 经 将 全 部 的 现 有 代 码 做 了 一 个 快 速 审 查 ， 发 现 很 多 东 西 需 要 改 进 。 这 也 是 创 建 一 个 简 短 的 路 线 图 和 修 正 你 的 反 馈 （ I S S U E ） 跟 踪 系 统 的 好 机 会 。 它 可 以 在 早 期 对 你 的 新 项 目 展 示 和 持 续 改 进 有 所 帮 助 。 在 D i f i o 项 目 上 ， 我 主 要 重 构 了 一 些 内 部 的 方 法 ， 让 它 适 应 新 的 应 用 程 序 结 构 。 外 部 的 方 法 被 留 到 以 后 解 决 ， 因 为 它 们 不 是 必 须 的 。 5 .   做 好 法 务 工 作 做 好 法 务 工 作 根 据 软 件 的 不 同 和 组 织 规 模 的 复 杂 性 ， 迁 移 到 开 源 也 许 是 相 当 耗 时 的 ， 从 选 择 合 适 的 许 可 证 、 品 牌 、 作 者 命 名 以 及 法 律 审 查 、 寻 找 潜 在 的 侵 权 代 码 等 等 ， 都 需 要 在 这 一 步 解 决 。 对 于 D i f i o 来 说 ， 这 倒 是 简 单 的 多 。 我 选 择 了 A p a c h e   2 . 0 协 议 ， 在 所 有 源 文 件 开 头 增 加 了 协 议 说 明 ， 并 妥 善 处 理 了 我 在 互 联 网 上 可 找 到 的 外 部 代 码 的 著 作 权 和 版 权 。 6 .   更 新 和 列 出 外 部 资 源 列 表 更 新 和 列 出 外 部 资 源 列 表 作 为 一 名 软 件 开 发 人 员 ， 你 必 须 及 时 将 引 用 的 外 部 软 件 升 级 到 最 新 版 本 ， 并 确 保 软 件 正 常 工 作 。 没 有 人 希 望 运 行 旧 的 外 部 程 序 ， 旧 的 外 部 程 序 有 时 会 无 法 正 常 运 行 。 你 还 需 要 提 供 一 个 列 表 ， 来 让 别 人 知 道 如 何 运 行 和 安 装 这 些 软 件 。 幸 运 的 是 ， D i f i o 中 只 有 有 限 的 问 题 和 程 序 依 赖 外 部 项 目 。 7 .   提 供 文 档 和 示 例 提 供 文 档 和 示 例 对 于 每 一 个 想 加 入 你 的 项 目 的 新 人 来 说 ， 文 档 是 非 常 重 要 的 。 毕 竟 你 开 源 是 希 望 引 起 大 家 的 参 与 ， 书 面 文 档 和 范 例 是 必 须 的 。 对 于 D i f i o ， 我 写 了 一 个 详 细 的 R E A D M E 文 件 ， 因 为 该 程 序 有 多 个 子 系 统 （ 消 息 传 递 、 c r o n 调 用 等 ） ， 它 有 很 多 配 置 方 式 。 我 创 建 的 第 二 个 文 档 是 一 个 内 容 管 理 指 南 ， 因 为 有 些 东 西 需 要 手 动 调 整 ， 这 两 个 文 件 囊 括 了 D i f i o 最 重 要 的 设 计 和 部 署 功 能 。 不 过 ， 你 可 能 需 要 为 你 的 项 目 写 更 多 的 其 他 文 档 。 8 .   创 建 一 个 公 共 代 码 库 创 建 一 个 公 共 代 码 库 你 需 要 创 建 一 个 公 共 的 代 码 仓 并 往 上 推 送 软 件 代 码 。 对 于 D i f i o ， 我 决 定 复 制 整 个 d i f i o / 目 录 下 的 内 容 ， 进 行 初 始 化 提 交 。 这 样 以 来 ， 以 前 的 历 史 就 无 法 使 用 了 ， 但 我 仍 然 决 定 这 么 做 ， 以 避 免 泄 露 在 硬 编 码 中 的 一 些 密 钥 和 密 码 。 在 实 际 开 发 中 ， 由 于 我 的 云 环 境 中 使 用 了 G i t 部 署 ， G i t 子 模 块 取 代 了 d i f i o / 目 录 ， 这 缩 短 了 发 布 / 部 署 周 期 。 从 现 在 开 始 ， 你 对 源 代 码 的 一 切 操 作 都 应 该 公 开 进 行 。 9 .   独 立 部 署 一 个 新 的 测 试 环 境 独 立 部 署 一 个 新 的 测 试 环 境 直 到 最 近 ， 你 可 能 一 直 在 本 地 副 本 里 操 作 来 自 于 特 定 版 本 的 应 用 程 序 ， 比 如 继 承 关 系 、 环 境 配 置 等 等 ， 但 在 一 个 新 的 环 境 里 从 外 部 用 户 的 角
度 测 试 将 会 帮 你 进 一 步 完 善 文 档 ， 清 理 遗 留 问 题 。 在 测 试 D i f i o 的 时 候 ， 我 发 现 了 几 个 缺 失 的 或 过 多 的 需 求 、 缺 少 或 不 恰 当 的 设 置 、 错 误 和 不 完 整 的 文 档 。 你 需 要 不 断 的 重 复 修 改 、 测 试 ， 直 到 每 一 步 都 是 合 理 的 、 开 箱 即 用 的 ， 这 将 确 保 你 的 用 户 和 未 来 的 贡 献 者 可 以 顺 利 安 装 你 的 软 件 。 1 0 .   对 外 宣 布 对 外 宣 布 这 是 最 后 一 步 了 ！ 写 一 篇   文 章 ， 对 外 宣 布 你 的 软 件 开 源 的 信 息 。 祝 贺 你 ！ 现 在 你 已 经 完 成 了 从 闭 源 到 开 源 的 转 换 ！ 英 文 原 文 ： 英 文 原 文 ：   O p e n S o u r c e   原 文 作 者 ：   A l e x a n d e r   T o d o r o v （ 开 源 大 叔 / 编 译 ） v i a :   h t t p : / / c o d e . c s d n . n e t / n e w s / 2 8 1 9 6 6 6 本 文 地 址 ： 阅 读 原 文
回复

举报

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

本版积分规则

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

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