microsoft / microsoft/vscode-pull-request-github

Ability to add comments in Markdown Preview Mode

Aperta
#8,607 0 commenti 14 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

feature-request
Lingua principale
TypeScript
Stelle
2.6k
Fork
796
Merge medio
1g 4h
PR unite (30g)
46

Descrizione

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

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia leggendo la precedente richiesta di funzionalità collegata, issue #5382, e ricostruendo come vengono gestiti Markdown Preview Mode e i review comments in questa estensione. Definisci l’interazione con l’anteprima e verifica che i reviewer possano selezionare contenuti Markdown, lasciare commenti e mantenere il contesto di review previsto senza passare alla vista del sorgente.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
github, typescript, vscode
Ambito
developer-experience, frontend
Tipo di issue
Funzionalità
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
45/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.