Aloittelija📝 Dokumentointi

Git-commit-viestin kirjoittaminen

Kirjoita selkeä ja informatiivinen commit-viesti.

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 changelog-merkintä muutoksille.

Aloittelija

README-tiedoston luonti

Luo kattava README-tiedosto projektille.

Aloittelija

JSDoc-kommenttien lisääminen

Lisää JSDoc-dokumentaatio koodille.

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