XHGit · 产品文档

议题与任务跟踪

提交问题、讨论、标签、里程碑、指派、时间跟踪与依赖。

01

阅读导览

议题(Issue,部分界面显示“工单”)用于记录问题、需求和讨论。它保存可追踪的上下文、负责人和处理状态,合并请求则承载准备合入的代码。仓库管理员可以关闭本地议题或改用外部系统,因此不同仓库的入口可能不同。

02

提交一份能被复现的问题

  1. 在仓库“议题”中先搜索关键词,查看开放和已关闭的记录,避免重复提交。
  2. 点击新建议题,按仓库提供的模板填写;没有模板时写明使用版本、操作步骤、实际结果和预期结果。
  3. 附上必要的错误日志或截图,删除验证码、令牌、真实个人资料和私有配置。
  4. 预览 Markdown,确认标题足以概括问题,再提交。

“打不开”很难定位,可以改成“登录后打开项目页返回 500”,并附上发生时间和最短复现步骤。上传附件是否可用,以及文件类型和大小限制,由站点配置决定。

03

使用 Markdown 组织讨论

正文和评论可写标题、列表、链接和代码块。代码块标注语言会方便阅读;大段日志应保留与故障有关的部分,不要用截图代替可复制的错误文字。

环境:测试环境,版本 0.1.0
步骤:进入项目页 → 选择某个筛选 → 刷新
预期:保留筛选结果
实际:筛选被重置

通过 #12 引用同仓库议题或合并请求,通过 @用户名 提及有权查看相关内容的人。引用和提及不会向对方授予私有仓库权限。补充信息时优先回复原讨论,使处理过程留在同一条记录里。

04

分配负责人和分类

有权限的维护者可以在侧栏设置指派人、标签、里程碑和项目。指派人表示谁负责跟进,标签表达类型、模块或优先级,里程碑关联一轮交付,项目用于看板组织。

  1. 先用少量稳定标签区分“缺陷”“需求”和“文档”。
  2. 指派到实际参与仓库的人,必要时在评论说明接手范围。
  3. 为准备交付的事项设置里程碑,不确定时间的讨论先留在待安排区域。
  4. 事项变化后更新侧栏信息,避免标签与真实状态脱节。

没有这些编辑按钮通常是权限不足,不能只靠发评论改变负责人或系统字段。

05

管理状态与订阅

开放表示仍需处理,关闭表示本轮处理结束;关闭并不自动意味着代码已经发布。关闭时写明结论、关联修复或不采纳理由,后续出现新证据可按权限重新打开。

关注议题后,可以在通知查看相关活动。邮件是否发送还取决于通知设置、邮箱验证、个人订阅和站点邮件服务。关闭浏览器页面不会取消关注;不需要继续接收时使用议题的取消订阅操作。

06

记录耗时和任务依赖

仓库启用时间跟踪后,符合权限的用户可使用计时器或手动记录耗时。开始工作时启动,结束时停止,检查单位和说明后保存。不要让计时器长期空转;输入错误时按页面允许的操作修正。

依赖功能启用后,可设置“被阻塞”和“阻塞”的关联事项。先确认方向:A 等待 B 完成,应把 B 设为 A 的前置阻塞项。无权查看的关联内容不会因为建立依赖而公开。功能是否可操作由仓库设置、成员身份及议题状态共同决定。

07

从议题走向代码和交付

  1. 在开发分支完成修改后创建合并请求。
  2. 在描述中关联议题,说明实现范围、测试结果和未解决部分。
  3. 使用仓库支持的关闭关键词,例如 Fixes #12 时,核对目标议题与实际合并流程;不要仅因为描述写了关键词就认定已经关闭。
  4. 合并后检查议题状态,在发布说明记录用户可见变化。

工作量较多时,用项目看板管理多个议题。普通论坛话题更适合社区交流,不要把同一份故障报告同时发到多个无关位置。

08

外部议题与访问失败

点击议题入口跳到其他网站,表示仓库使用了外部跟踪系统。本地议题、评论和权限不会自动复制到该系统,提交时遵守对方登录要求。设置错误需要仓库管理员修正“外部议题系统 URL”,它不是“外部 Wiki URL”。遇到 404 先确认仓库和议题读取权限,再联系维护者核对功能开关。