Keskitaso📝 Dokumentointi

Koodikatselmus-riskiyhteenveto

Luo PR:stä tiivis riskikatselmus reviewerille.

Prompti

Laadi tämän muutoksen riskitiivistelmä koodikatselmukseen.

Muutos:
[MUUTOS]

Diff:
[DIFF]

Tuota:
1) Korkean riskin kohdat
2) Mitä pitää testata manuaalisesti
3) Mitkä osat ovat turvallisia
4) Yksi suositeltu review-järjestys

Suomenkieliset vinkit

  • Sana "tiivistelmä" pakottaa vastaamaan olennaiseen

Muuttujat

Korvaa nämä hakasulkeissa olevat muuttujat omilla tiedoillasi:

  • [MUUTOS]
  • [DIFF]

Esimerkki

Täytetty prompti

Laadi tämän muutoksen riskitiivistelmä koodikatselmukseen.

Muutos:
Kirjautumisen refaktorointi middlewareen

Diff:
[tiivistelmä diffistä]

Tulos

Reviewer näkee heti mihin huomio pitää kohdistaa.

Vinkit

  • Anna myös liiketoimintakonteksti
  • Pyydä review-järjestys
  • Tee tästä PR-template osio

Milloin käyttää

  • PR on iso tai kriittinen
  • Review-aika on rajallinen
  • Haluat vähentää läpimenovirheitä

Liittyvät promptit

PR-kuvauksen kirjoittaminen

Kirjoita selkeä PR-kuvaus koodimuutoksille.

Aloittelija

Legacy-koodin riskikartoitus

Tunnista legacy-moduulin suurimmat riskit ennen refaktorointia.

Edistynyt

JSDoc-kommenttien lisääminen

Lisää JSDoc-dokumentaatio funktioille ja moduuleille niin, että IDE näyttää hyödylliset vihjeet. Kattaa parametrit, palautusarvot ja käyttöesimerkit.

Aloittelija

Hyödyllisiä resursseja

Cursor-oppaat

Opi käyttämään prompteja Cursorissa tehokkaasti.

→

Projekti-ideat

Käytä prompteja omissa projekteissasi.

→

Sanasto

Opi vibekoodauksen terminologia.

→

Lisää prompteja

Selaa kaikkia dokumentointi prompteja tai tutustu muihin kategorioihin.

Kaikki dokumentointi promptitKaikki kategoriat