microsoft / microsoft/vscode-pull-request-github

Ability to add comments in Markdown Preview Mode

Đang mở
#8,607 0 bình luận 14 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

feature-request
Ngôn ngữ chính
TypeScript
Star
2.6k
Fork
796
Merge trung bình
1 ngày 4 giờ
Pull request đã merge (30 ngày)
46

Mô tả

Request

Please add support for leaving review comments while viewing a Markdown file in Preview Mode.

Reasoning

As AI-assisted workflows become more common, more of the important review context is showing up in Markdown files, not just code. Things like planning docs, specs, implementation notes, READMEs, and BMAD-style workflow docs are becoming a much bigger part of the review process.

Preview Mode is the best way to review that content because it shows the Markdown as it is actually intended to be read. But right now, if I want to leave a review comment, I have to switch back to the raw Markdown source. That breaks the flow and makes it harder to review and comment on symbol heavy components; such as tables, ascii diagrams, etc.

It would be really helpful to support comments directly from Preview Mode since it would make reviewing Markdown-heavy PRs much smoother and more natural.


Examples

BMad Method, where teams work through Markdown artifacts such as PRDs, architecture documents, story files, and user guides, and Superpowers, which uses Markdown specs and implementation plans as key workflow artifacts. In these kinds of frameworks, Markdown files are not just supporting docs; they are a primary medium for planning, review, and inter-agent coordination.


I am aware of this previous feature-request post, but it was made 2+ years ago and seems like it never went anywhere. I think the importance of this has changed drastically since then. - https://github.com/microsoft/vscode-pull-request-github/issues/5382

Hướng dẫn đóng góp

Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Hướng nghiên cứu

Bắt đầu bằng cách đọc yêu cầu tính năng trước đó được liên kết, issue #5382, và lần theo cách Markdown Preview Mode và review comments được xử lý trong extension này. Xác định cách tương tác với bản xem trước và xác minh rằng reviewer có thể chọn nội dung Markdown, để lại comment và giữ nguyên ngữ cảnh review như mong đợi mà không chuyển sang chế độ xem mã nguồn.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Đánh giá

Công nghệ
github, typescript, vscode
Lĩnh vực
developer-experience, frontend
Loại issue
Tính năng
Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức độ hoạt động
Đình trệ
Độ rõ ràng
Khá rõ ràng
Mức phù hợp với người mới
45/100

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.