Aloittelija📝 Dokumentointi

Git-commit-viestin kirjoittaminen

Kirjoita selkeä ja informatiivinen commit-viesti.

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 git commit -viesti seuraaville muutoksille.

Muutokset:
[MUUTOKSET]

Konteksti:
[KONTEKSTI]

Noudata Conventional Commits -formaattia:
- type(scope): description
- Tyhjä rivi
- Tarkempi kuvaus tarvittaessa
- Breaking changes

Tyypit: feat, fix, docs, style, refactor, test, chore

Suomenkieliset vinkit

Commit-viestit ja PR-kuvaukset voi kirjoittaa suomeksi suomalaisissa tiimeissä
Suomenkieliset promptit toimivat hyvin Claude- ja GPT-4-malleissa
Voit sekoittaa suomea ja englantia — teknisiä termejä ei tarvitse kääntää

Muuttujat

Korvaa nämä hakasulkeissa olevat muuttujat omilla tiedoillasi:

[MUUTOKSET]
[KONTEKSTI]

Esimerkki

Täytetty prompti

Kirjoita git commit -viesti seuraaville muutoksille.

Muutokset:
- Lisätty käyttäjän profiilisivu
- Uusi Avatar-komponentti
- Profiilin muokkauslomake
- API-endpoint profiilin päivitykseen

Konteksti:
Osa käyttäjähallinnan laajennusta

Noudata Conventional Commits -formaattia.

Tulos

Formatoitu commit-viesti.

Vinkit

Listaa kaikki muutokset
Anna konteksti miksi muutos tehtiin
Mainitse breaking changes

Milloin käyttää

Haluat selkeän commit-historian
Tiimityö vaatii standardin
Automaattinen changelog

Liittyvät promptit

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