搜索

[25789] 2016-11-30_玩转GitHub的问题单（issue）

文档创建者：s7ckTeam
浏览次数：1
最后更新：2025-01-19
2016-11-30_玩转GitHub的问题单（issue） - -   M a t t   B u t l e r 1 1 % 3 9 % 4 9 % 5 8 % 7 5 % 玩 转   G i t H u b   的 问 题 单 （ i s s u e ） 原 创   译 者 ： e c h o m a   L i n u x 中 国   2 0 1 6 - 1 1 - 3 0 “ 问 题 单 模 板 、 合 理 的 标 签 、 提 交 问 题 单 的 指 导 文 档 、 确 保 问 题 单 被 分 类 并 及 时 回 应 ， 这 些 对 于 开 源 项 目 都 至 关 重 要 ” ， B a c o n   说 。 本 文 导 航 - 问 题 单 就 是 用 户 的 故 事 - 高 质 量 的 问 题 单 - 不 满 足 上 述 条 件 的 问 题 单 呢 ?   要 有 约 束 - 问 题 单 里 面 有 什 么 ？ - 团 队 协 同 一 致 对 于 大 多 数 开 源 项 目 来 讲 ， I s s u e - t r a c k i n g   s y s t e m 问 题 追 踪 系 统 是 至 关 重 要 的 。 虽 然 有 非 常 多 的 开 源 工 具 提 供 了 这 样 的 功 能 ， 但 是 大 量 项 目 还 是 选 择 了   G i t H u b   自 带 的 I s s u e   T r a c k e r 问 题 追 踪 器 。 它 结 构 简 单 ， 可 以 让 其 他 人 可 以 非 常 轻 松 地 参 与 进 来 ， 但 这 才 仅 仅 是 开 始 。 如 果 没 有 适 当 的 处 理 ， 你 的 r e p o s i t o r y 储 存 库 会 变 得 很 庞 大 ， 挤 满 重 复 的 问 题 单 、 模 糊 不 明 的 特 性 需 求 单 、 含 混 的   b u g   报 告 单 。 项 目 维 护 者 会 被 大 量 工 作 压 得 喘 不 过 气 来 ， 新 的 贡 献 者 也 搞 不 清 楚 项 目 当 前 的 工 作 重 点 是 什 么 。 接 下 来 ， 我 们 一 起 研 究 下 ， 如 何 玩 转   G i t H u b   的 问 题 单 。
问 题 单 就 是 用 户 的 故 事 问 题 单 就 是 用 户 的 故 事 我 的 团 队 曾 经 和 开 源 专 家   J o n o   B a c o n [ 1 ]   做 过 一 次 对 话 ， 他 是 T h e   A r t   o f   C o m m u n i t y 《 社 区 艺 术 》 [ 2 ] 一 书 的 作 者 、 一 位 战 略 顾 问 、 前   G i t H u b   社 区 总 监 。 他 告 诉 我 们 ， 高 质 量 的 问 题 单 是 项 目 成 功 的 关 键 。 有 些 人 把 问 题 单 仅 仅 看 作 是 一 堆 你 不 得 不 去 处 理 的 问 题 列 表 ， 但 是 如 果 这 些 问 题 单 管 理 完 善 ， 进 行 了 分 类 并 打 上 标 签 ， 会 令 人 意 想 不 到 的 提 升 我 们 对 代 码 和 社 区 的 了 解 程 度 ， 也 让 我 们 更 清 楚 问 题 的 关 键 点 在 哪 里 。 “ 在 提 交 问 题 单 时 ， 用 户 不 太 会 有 耐 心 或 者 有 兴 趣 把 问 题 的 细 节 描 述 清 楚 。 在 这 种 情 况 下 ， 你 应 当 努 力 花 最 短 的 时 间 ， 尽 量 多 的 获 取 有 用 的 信 息 。 ” ， J o n o   B a c o n   说 。 统 一 的 问 题 单 模 板 可 以 大 大 减 轻 项 目 维 护 者 的 负 担 ， 尤 其 是 开 源 项 目 的 维 护 者 。 我 们 发 现 ， 让 用 户 讲 故 事 的 方 法 总 是 可 以 把 问 题 描 述 的 非 常 清 楚 。 用 户 讲 故 事 时 需 要 说 明 “ 是 谁 ， 做 了 什 么 ， 为 什 么 而 做 ” ， 也 就 是 ： 我 是 【 何 种 用 户 】 ， 为 了 【 达 到 何 种 目 的 】 ， 我 要 【 做 何 种 操 作 】 。 实 际 操 作 起 来 ， 大 概 是 这 样 的 ： 我 是 一 名 顾 客 ， 我 想 购 买 东 西 ， 所 以 我 想 创 建 个 账 户 。 我 们 建 议 ， 问 题 单 的 标 题 始 终 使 用 这 样 的 用 户 故 事 形 式 。 你 可 以 设 置 问 题 单 模 板 [ 3 ] 来 保 证 一 致 性 。 问 题 单 模 板 让 特 性 需 求 单 保 持 统 一 的 形 式 这 个 做 法 的 核 心 点 在 于 ， 问 题 单 要 清 晰 的 呈 现 给 它 涉 及 的 每 一 个 人 ： 它 要 尽 量 简 单 的 指 明 受 众 （ 或 者 说 用 户 ） ， 操 作 （ 或 者 说 任 务 ） ， 和 输 出 （ 或 者 说 目 标 ） 。 不 过 ， 不 需 要 过 分 拘 泥 于 这 个 模 板 ， 只 要 能 把 故 事 里 的 是 什 么 事 情 或 者 是 什 么 原 因 说 清 楚 ， 就 达 到 目 的 了 。 高 质 量 的 问 题 单 高 质 量 的 问 题 单 问 题 单 的 质 量 是 参 差 不 齐 的 ， 这 一 点 任 何 一 个 开 源 软 件 的 贡 献 者 或 维 护 者 都 能 证 实 。 在 《 T h e   A g i l e   S a m u r a i 》 [ 4 ] 中 概 述 过 一 个 良 好 的 问 题 单 所 应 具 备 的 素 质 。
好 的 问 题 单 尽 量 满 足 如 下 条 件 ： 客 户 价 值 所 在 避 免 使 用 术 语 或 晦 涩 的 文 字 ， 就 算 不 是 专 家 也 能 看 懂 可 以 切 分 ， 也 就 是 说 我 们 可 以 逐 步 解 决 问 题 尽 量 跟 其 他 问 题 单 没 有 瓜 葛 ， 依 赖 其 它 问 题 会 降 低 处 理 的 灵 活 性 可 以 协 商 ， 也 就 说 我 们 有 好 几 种 办 法 达 到 目 标 问 题 足 够 小 ， 可 以 非 常 容 易 的 评 估 出 所 需 时 间 和 资 源 可 衡 量 ， 我 们 可 以 对 结 果 进 行 测 试 不 满 足 上 述 条 件 的 问 题 单 呢 不 满 足 上 述 条 件 的 问 题 单 呢 ?   要 有 约 束 要 有 约 束 如 果 一 个 问 题 单 很 难 衡 量 ， 或 者 很 难 在 短 时 间 内 完 成 ， 你 也 一 样 有 办 法 搞 定 它 。 有 些 人 把 这 种 办 法 叫 做 “ 约 束 ” （ c o n s t r a i n t s ） 。 例 如 ， “ 这 个 产 品 要 快 ” ， 这 种 问 题 单 不 符 合 故 事 模 板 ， 而 且 是 没 办 法 协 商 的 。 多 快 才 是 快 呢 ？ 这 种 模 糊 的 需 求 没 有 达 到 “ 好 问 题 单 ” 的 标 准 ， 但 是 如 果 你 进 一 步 定 义 一 下 ， 例 如 “ 每 个 页 面 都 需 要 在   0 . 5   秒 内 加 载 完 ” ， 那 我 们 就 能 更 轻 松 地 解 决 它 了 。 我 们 可 以 把 “ 约 束 ” 看 作 是 成 功 的 标 尺 ， 或 者 要 实 现 的 里 程 碑 。 每 个 团 队 都 应 该 定 期 的 对 “ 约 束 ” 进 行 测 试 。 问 题 单 里 面 有 什 么 ？ 问 题 单 里 面 有 什 么 ？ 敏 捷 方 法 中 ， 用 户 故 事 里 通 常 要 包 含 验 收 指 标 或 者 标 准 。 在   G i t H u b   里 ， 建 议 大 家 使 用   m a r k d o w n   格 式 的 清 单 来 概 括 解 决 这 个 问 题 单 需 要 完 成 的 任 务 。 优 先 级 越 高 的 问 题 单 应 当 包 含 更 多 的 细 节 。 比 如 说 ， 你 打 算 提 交 一 个 关 于 新 版 网 站 主 页 的 问 题 单 。 那 这 个 问 题 单 的 子 任 务 列 表 可 能 就 是 这 样 的 ： 使 用   m a r k d o w n   的 清 单 把 复 杂 问 题 拆 分 成 多 个 部 分 在 必 要 的 情 况 下 ， 你 还 可 以 链 接 到 其 他 问 题 单 ， 以 进 一 步 明 确 任 务 。 （ G i t H u b   里 做 这 个 挺 方 便 的 ） 将 特 性 定 义 的 越 细 化 ， 越 容 易 跟 踪 进 度 、 测 试 ， 最 终 能 更 高 效 的 发 布 有 价 值 的 代 码 。 以 问 题 单 的 形 式 收 到 到 问 题 所 在 后 ， 还 可 以 用   A P I   更 深 入 的 了 解 软 件 的 健 康 度 。 “ 在 统 计 问 题 单 的 类 型 和 趋 势 时 ， G i t H u b   A P I   可 以 发 挥 巨 大 作 用 ” ， B a c o n   告 诉 我 们 ， “ 如 果 再 做 些 数 据 挖 掘 工 作 ， 你 就 能 发
现 代 码 里 的 问 题 点 、 社 区 里 的 活 跃 成 员 ， 或 者 其 他 有 用 的 信 息 。 ” 有 些 问 题 单 管 理 工 具 提 供 的   A P I   可 以 提 高 额 外 信 息 ， 比 如 预 估 时 间 或 者 历 史 进 度 。 团 队 协 同 一 致 团 队 协 同 一 致 团 队 决 定 使 用 某 种 问 题 单 模 板 后 ， 如 何 让 所 有 人 都 照 做 ？ 存 储 库 里 的   R e a d M e . m d   其 实 也 可 以 是 你 们 项 目 的   “ H o w - t o ”   文 档 。 这 个 文 档 应 描 述 清 楚 这 个 项 目 是 做 什 么 的 （ 最 好 是 用 可 以 搜 索 的 语 言 ） ， 以 及 其 他 贡 献 者 应 当 如 何 参 与 进 来 （ 比 如 提 交 需 求 单 、 b u g   报 告 、 建 议 ， 或 者 直 接 贡 献 代 码 ） 。 在   R e a d M e   文 件 里 增 加 清 晰 的 说 明 ， 供 新 协 作 者 参 考 R e a d M e   文 件 是 提 供 “ 问 题 单 指 引 ” 的 完 美 场 所 。 如 果 希 望 特 性 需 求 单 遵 循 “ 用 户 讲 故 事 ” 的 格 式 ， 那 就 把 格 式 写 在   R e a d M e 里 。 如 果 使 用 某 种 跟 踪 工 具 来 管 理 待 办 事 项 ， 那 就 标 记 在   R e a d M e   里 ， 这 样 别 人 也 能 看 到 。 “ 问 题 单 模 板 、 合 理 的 标 签 、 提 交 问 题 单 的 指 导 文 档 、 确 保 问 题 单 被 分 类 并 及 时 回 应 ， 这 些 对 于 开 源 项 目 都 至 关 重 要 ” ， B a c o n   说 。 记 住 一 点 ： 这 不 是 为 了 完 成 工 作 而 做 的 工 作 。 这 是 让 其 他 人 更 轻 松 的 发 现 、 了 解 、 融 入 你 的 社 区 而 设 立 的 规 则 。 " 关 注 社 区 的 成 长 ， 不 仅 要 关 注 参 与 开 发 者 的 的 数 量 增 长 ， 也 要 关 注 那 些 在 问 题 单 上 帮 助 我 们 的 人 ， 他 们 让 问 题 单 更 加 明 确 、 保 持 更 新 ， 这 是 活 跃 沟 通 和 高 效 解 决 问 题 的 力 量 源 泉 " ， B a c o n   说 。 v i a :   h t t p s : / / o p e n s o u r c e . c o m / l i f e / 1 6 / 7 / h o w - t a k e - y o u r - p r o j e c t s - g i t h u b - i s s u e s - g o o d - g r e a t 作 者 ： M a t t   B u t l e r [ 5 ]   译 者 ： e c h o m a   校 对 ： j a s m i n e p e n g 本 文 由   L C T T [ 6 ]   原 创 翻 译 ， L i n u x 中 国   荣 誉 推 出 推 荐 文 章 滑 动 查 看 更 多
输 入 文 章   I D   或 长 按 二 维 码 直 达 [ 1 ] :   h t t p : / / w w w . j o n o b a c o n . o r g / [ 2 ] :   h t t p : / / w w w . a r t o f c o m m u n i t y o n l i n e . o r g / [ 3 ] :   h t t p s : / / h e l p . g i t h u b . c o m / a r t i c l e s / c r e a t i n g - a n - i s s u e - t e m p l a t e - f o r - y o u r - r e p o s i t o r y / [ 4 ] :   h t t p s : / / w w w . a m a z o n . c a / A g i l e - S a m u r a i - M a s t e r s - D e l i v e r - S o f t w a r e / d p / 1 9 3 4 3 5 6 5 8 1 [ 5 ] :   h t t p s : / / o p e n s o u r c e . c o m / u s e r s / m a t t z e n h u b [ 6 ] :   h t t p s : / / g i t h u b . c o m / L C T T / T r a n s l a t e P r o j e c t 阅 读 原 文
回复

举报

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

本版积分规则

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

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