microsoft / microsoft/vscode-pull-request-github

Ability to add comments in Markdown Preview Mode

Abierto
#8,607 0 comentarios 14 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

feature-request
Lenguaje dominante
TypeScript
Estrellas
2.6k
Forks
795
Merge medio
1 d 4 h
PR fusionados (30 d)
46

Descripción

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

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

Comienza leyendo la solicitud de funcionalidad anterior enlazada, issue #5382, y siguiendo cómo se gestionan Markdown Preview Mode y los review comments en esta extensión. Define la interacción con la vista previa y verifica que los revisores puedan seleccionar contenido Markdown, dejar comentarios y conservar el contexto de revisión esperado sin cambiar a la vista de origen.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
github, typescript, vscode
Área
developer-experience, frontend
Tipo de issue
Nueva funcionalidad
Dificultad
4/5
Tiempo estimado
3-5 días
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
45/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.