Aloittelija📝 Dokumentointi

PR-kuvauksen kirjoittaminen

Kirjoita selkeä PR-kuvaus koodimuutoksille.

Suora vastaus: mitä tämä sivu antaa?

  • Valmis promptimalli: voit kopioida sen sellaisenaan ja muokata muuttujat omaan tilanteeseen.
  • Nopea käyttöönotto: mukana on täytetty esimerkki ja selitys milloin promptia kannattaa käyttää.
  • Jos tarvitset työkalun käyttöohjeen: jatka Cursor-oppaisiin osoitteessa `/vibekoodaus/cursor`.

Prompti

Kirjoita Pull Request -kuvaus seuraaville muutoksille.

Muutokset:
[MUUTOKSET]

Liittyvä issue: [ISSUE]

Sisällytä:
## Kuvaus
## Muutokset
## Testaus
## Screenshotit (tarvittaessa)
## Checklist
- [ ] Koodi on testattu
- [ ] Dokumentaatio päivitetty
- [ ] Ei breaking changeja

## Miten testata

Suomenkieliset vinkit

  • Commit-viestit ja PR-kuvaukset voi kirjoittaa suomeksi suomalaisissa tiimeissä
  • Suomenkielinen dokumentaatio on arvokasta suomalaisille tiimeille
  • Lisää 'vastaa suomeksi' promptin loppuun jos AI vastaa englanniksi

Muuttujat

Korvaa nämä hakasulkeissa olevat muuttujat omilla tiedoillasi:

  • [MUUTOKSET]
  • [ISSUE]

Esimerkki

Täytetty prompti

Kirjoita Pull Request -kuvaus seuraaville muutoksille.

Muutokset:
- Implementoitu tuotteen hakutoiminto
- Lisätty debounce-haku
- Hakutulokset näytetään dropdown-listassa
- Keyboard-navigaatio tuloksissa

Liittyvä issue: #42

Sisällytä Kuvaus, Muutokset, Testaus, Checklist, Miten testata.

Tulos

Täydellinen PR-kuvaus.

Vinkit

  • Kuvaile muutokset selkeästi
  • Linkitä liittyvä issue
  • Kerro miten testata

Milloin käyttää

  • Avaat Pull Requestin
  • Tiimityö vaatii selkeät PR:t
  • Haluat nopean reviewin

Liittyvät promptit

Git-commit-viestin kirjoittaminen

Kirjoita selkeä ja informatiivinen commit-viesti.

Aloittelija

Changelog-merkinnän luonti

Luo selkeä changelog-merkintä joka kertoo mitä muuttui, miksi ja miten se vaikuttaa käyttäjiin. Noudattaa Keep a Changelog -muotoa ja semantic versioning -periaatteita.

Aloittelija

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