Skip to content

[r2cn] 实现code review 的代码行内评论功能 #1793

@benjamin-747

Description

@benjamin-747

[任务] 实现code review 的代码行内评论功能

[任务分值] 35 分

[背景描述]

当前系统已具备基础的代码 Review 能力(如查看 diff、整体评论等),但在 Review 过程中仍存在明显体验与效率问题:

  1. 缺乏精确的评论定位能力
    Reviewer 只能:
  • 进行整体评论
  • 或在 Review 维度给出抽象反馈
  • 无法将评论精确绑定到某个文件的某一行或某一段代码

[需求描述]

  1. 支持在代码 Diff 的行级别添加评论
    基本能力:
  • 在 Code Review 的 diff 视图中:
    • 支持对 新增 / 修改的代码行 添加评论

评论需精确关联到:

  • 文件路径(file path)
  • 行号(line number)
  • Diff 侧(旧代码 / 新代码)
  1. 行内评论的展示与交互
    展示要求:
  • 在代码行旁显示评论入口(如 hover / 按钮)
  • 已有评论的代码行:
    • 显示评论标记
    • 可展开查看评论内容
  • 多条评论可形成一个 评论线程(thread)
  1. 评论线程(Thread)模型

行为定义:

  • 一个行内评论线程包含:
    • 初始评论
    • 若干回复
  • 线程状态:
    • open
    • resolved(可选,后续支持)
  • 支持:
    • 新增回复
    • 查看历史回复顺序

[代码标准]

  1. 所有 PR 提交必须签署 Signed-off-by 和 使用 GPG 签名,即提交代码时(使用 git commit 命令时)至少使用 -s -S 两个参数,参考 Contributing Guide
  2. 所有 PR 提交必须通过 GitHub Actions 自动化测试,提交 PR 后请关注 GitHub Actions 结果;
  3. 代码注释均需要使用英文;

[PR 提交地址] 提交到 mega 仓库的 main 分支 `` 目录;

[开发指导]

  1. 认领任务参考 r2cn 开源实习计划 - 任务认领与确认;

[导师及邮箱] 请申请此题目的同学使用邮件联系导师,或加入到 R2CN Discord 后在 #p-meta 频道和导师交流。

  1. Quanyi Ma genedna@gmail.com
  2. Tianxing Ye yetianxing2014@gmail.com

[备注]

  1. 认领实习任务的同学,必须完成测试任务和注册流程,请参考: r2cn 开源实习计划 - 测试任务r2cn 开源实习计划 - 学生注册与审核

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions