Aloittelija📝 Dokumentointi

Pull Request -kuvauksen kirjoittaminen

Kirjoita selkeä PR-kuvaus koodimuutoksille.

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.

Changelog-merkinnän luonti

Luo changelog-merkintä muutoksille.

JSDoc-kommenttien lisääminen

Lisää JSDoc-dokumentaatio koodille.

Hyödyllisiä resursseja

Lisää prompteja

Selaa kaikkia dokumentointi prompteja tai tutustu muihin kategorioihin.

Kaikki dokumentointi promptit Kaikki kategoriat