aws / aws/sagemaker-code-editor

Add comments to summarize changes at top of each patch

Offen
#12 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
Vorherrschende Sprache
TypeScript
Sterne
16
Forks
35
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

For each patch in `series`, we should add comments at the top of each patch and explain what it's for and how to test the functionality

(03/08/24) Another link was added for `webview.diff` patch to evaluate `script-src` to explain how we made this change (see 2nd comment link below)

Original comment: https://github.com/aws/sagemaker-code-editor/pull/11#discussion_r1515280546

2nd comment: https://github.com/aws/sagemaker-code-editor/pull/13/files#r1518235315

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Prüfe die Patches in `series`, einschließlich `webview.diff`, und sieh dir die referenzierten Pull-Request-Diskussionen an, um die erwarteten Erklärungen zu ermitteln. Füge am Anfang jedes Patches einen Kommentar hinzu, der den Zweck des Patches und seine Testmethode beschreibt; als erledigt gilt die Aufgabe, wenn jeder Patch beide Angaben enthält.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

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