microsoft / microsoft/vscode-pull-request-github

Ability to add comments in Markdown Preview Mode

Offen
#8,607 0 Kommentare 14 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

feature-request
Vorherrschende Sprache
TypeScript
Sterne
2.6k
Forks
795
Ø Merge
1 T. 4 Std.
Gemergte PRs (30 T.)
46

Beschreibung

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

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne damit, die verknüpfte vorherige Feature-Anfrage, Issue #5382, zu lesen und nachzuverfolgen, wie Markdown Preview Mode und review comments in dieser Extension behandelt werden. Definiere die Interaktion mit der Vorschau und überprüfe, dass Reviewer Markdown-Inhalte auswählen, Kommentare hinterlassen und den erwarteten Review-Kontext beibehalten können, ohne zur Quellansicht zu wechseln.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
github, typescript, vscode
Bereich
developer-experience, frontend
Issue-Typ
Feature
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
45/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.