Încă nimic. Lipește câteva linii mai sus și apasă Generează.Ce face cu fiecare linie
Regulile sunt intenționat simple și vizibile, ca să poți prezice rezultatul în loc să-l ghicești:
- Conventional commit-urile sunt grupate după tip. `feat` devine Nou, `fix` devine Corectat, `perf` devine Îmbunătățit. Un `!` înainte de două puncte, sau un marcaj BREAKING CHANGE, mută linia la Modificări incompatibile indiferent de tipul ei.
- Orice nu este un conventional commit este sortat după primul cuvânt. Add, Added, Introduce și Support devin Nou; Fix, Fixed și Resolve devin Corectat; Improve, Update, Speed și Optimise devin Îmbunătățit; Remove, Removed, Drop și Deprecate devin Eliminat. Orice altceva ajunge la Altele ca să-l sortezi manual.
- Zgomotul este eliminat: un număr de pull request la final, o linie `Merge pull request ...`, un scope între paranteze și chiar prefixul de tip conventional. Propoziția rămasă este scrisă cu literă mare.
- Cu filtrul activat, liniile `chore`, `ci`, `test`, `build`, `style` și `refactor` sunt eliminate, împreună cu orice arată ca o actualizare de dependență. Aceasta este cea mai mare diferență între un changelog pe care oamenii îl citesc și unul pe care încetează să-l citească.
Ce nu poate face
Rescrie forma mesajelor tale de commit, nu conținutul lor. Dacă un commit spune `fix: race in MembershipCache.resolve()`, asta iese, și tot este o propoziție despre codul tău, nu despre experiența utilizatorului. Transformarea „race in MembershipCache” în „membrii invitați nu mai văd un panou gol” necesită să știi ce a făcut modificarea, care este partea pe care un generator nu o poate deduce dintr-o linie de subiect de commit.
Deci tratează rezultatul ca o primă trecere: structură corectă, grupare corectă, zgomot intern deja dispărut, formularea încă trebuie corectată de tine.
Întrebări frecvente
Ce lipesc este încărcat undeva?
Nu. Generatorul este un script pe această pagină; textul nu părăsește niciodată browserul tău și nu există nicio cerere către noi când apeși Generează. Poți confirma asta cu tab-ul de rețea deschis.
Trebuie să folosesc conventional commits?
Nu. Liniile care urmează convenția sunt grupate mai precis, iar tot restul revine la verbul de la început. Un repozitoriu cu mesaje de commit obișnuite, tip propoziție, tot produce o ciornă utilizabilă.
Cum obțin asta automat din repozitoriul meu?
Pentru o utilizare unică, `git log --pretty=format:%s v1.2.0..HEAD` îți dă exact intrarea la care se așteaptă asta. Pentru ceva continuu, git-cliff și github-changelog-generator construiesc amândouă un fișier changelog în CI din istoricul tău de commit-uri, iar Changeloop redactează o intrare orientată către utilizator per pull request îmbinat și o păstrează pentru recenzie.
De ce rezultatul meu este plin de Altele?
Verbele de la început nu s-au potrivit cu nimic cunoscut, ceea ce de obicei înseamnă subiecte de commit care încep cu un substantiv sau un id de tichet. Fie editează-le în casetă înainte de generare, fie mută liniile din Altele manual după aceea.
Lectură suplimentară: de la conventional commits la un changelog, despre ce cumpără formatul de commit și unde se oprește.
Versiunea care scrie și propozițiile
Changeloop citește titlul și descrierea fiecărui pull request îmbinat, nu doar linia de subiect, și redactează o intrare despre ce s-a schimbat pentru utilizator. Filtrează singur actualizările de dependențe și refactorizările, și păstrează fiecare ciornă pentru ca tu s-o editezi înainte de publicare. Gratuit pentru un repozitoriu, fără card.
Începe gratuit