Beste praksis for commit-meldinger
Ta i bruk konvensjoner for å skrive tydelige, konsise og informative commit-meldinger som gjør prosjektets historikk enklere å lese.
Beste praksis for commit-meldinger er en gratis leksjon i Profesjonell arbeidsflyt med Git og GitHub på CoddyKit. Dette er leksjon 3 av 4. Du kan lese hele leksjonen gratis nedenfor – og deretter øve praktisk i nettleseren med en innebygd kodeeditor og en AI-veileder som er tilgjengelig døgnet rundt. Den er en del av læringsløpet i Profesjonell arbeidsflyt med Git og GitHub, og fremdriften din synkroniseres mellom nettet og CoddyKit-appen. Kurset i Profesjonell arbeidsflyt med Git og GitHub inneholder totalt 4 leksjoner.
Hvorfor gode commiter er viktige
Se for Dem at De går tilbake til prosjektets historikk. Uten tydelige commit-meldinger er det som å lese en dagbok med tomme oppføringer!
Gode commit-meldinger er avgjørende for å forstå hvorfor endringer ble gjort, hva som ble endret, og hvordan endringene påvirker prosjektet. Dette hjelper Dem og teamet med feilsøking, kodegjennomgang og opplæring av nye medlemmer.
En commit-meldings anatomi
En standard Git-commit-melding består av to hoveddeler:
- Emnelinje: Én kortfattet linje som oppsummerer endringen.
- Brødtekst (valgfritt): En mer detaljert forklaring, adskilt fra emnelinjen med en tom linje.
Tenk på det som en e-post: en emnelinje for rask oversikt og en brødtekst med detaljer.
Skriv emnelinjen
Emnelinjen er den viktigste delen. Her er reglene:
- Kortfattet: Begrens den til 50–72 tegn.
- Imperativ: Start med et verb i presens, for eksempel «Add feature», ikke «Added feature» eller «Adding feature».
- Stor forbokstav: Dette er vanlig praksis for bedre lesbarhet.
- Ingen punktum: Ikke avslutt emnelinjen med punktum.
Eksempler på emnelinjer
La oss se på noen gode og dårlige emnelinjer:
- God:
Fix: broken login button - God:
Feat: implement user profile page - Dårlig:
Fixed a bug in the login system that was causing issues.(For lang, fortid) - Dårlig:
updates(For vag)
Sikt mot tydelighet og kortfattethet!
Commit-brødteksten: Forklar «hvorfor»
I commit-brødteksten forklarer De motivasjonen for endringen, konteksten og eventuelle detaljer som ikke er åpenbare ut fra selve koden.
Bruk den når endringen trenger mer forklaring enn det emnelinjen kan gi. Begrens linjene til rundt 72 tegn for bedre lesbarhet i Git-verktøy.
Retningslinjer for brødteksten
Når De skriver brødteksten:
- Forklar hvorfor endringen ble gjort, ikke bare hva som ble endret.
- Beskriv eventuelle avveininger eller designbeslutninger.
- Omtal mulige bivirkninger eller områder som bør følges med på.
- Ha en tom linje mellom emnelinjen og brødteksten.
Dette gir verdifull kontekst for fremtidige lesere.
Eksempel på en fullstendig commit-melding
Slik kan en fullstendig og velstrukturert commit-melding se ut:
feat: add user authentication via email/password
This commit introduces a new user authentication system.
Users can now register with an email and password, and log in.
Key changes include:
- New /register and /login API endpoints.
- Integration with bcrypt for password hashing.
- JWT token generation for session management.
Closes #42Bruk typeprefikser (Conventional Commits)
Mange team følger en konvensjon der emnelinjen begynner med et typeprefiks. Dette gjør det enklere å kategorisere endringer raskt.
Vanlige prefikser inkluderer:
feat:(ny funksjon)fix:(feilretting)docs:(endring i dokumentasjon)style:(kodestil, ingen funksjonell endring)refactor:(refaktorering av kode)test:(legge til tester)chore:(vedlikehold og endringer i byggeprosessen)
Referer til issues og PR-er
Det er god praksis å knytte commiter til relaterte issues eller pull requests i prosjektstyringssystemet Deres, for eksempel GitHub Issues eller Jira.
Dette kan De gjøre ved å ta med uttrykk som Closes #123, Fixes #45 eller Refs #67 i commit-meldingen, vanligvis i brødteksten. Da kobles kodeendringene automatisk til oppgaven som spores.
Kontroll av commit-meldinger
Hvilke av følgende kjennetegn har en velskrevet Git-commit-melding i henhold til beste praksis?
Oppsummering: Få kontroll på commitene
De har lært at godt utformede commit-meldinger er avgjørende for tydelighet i prosjektet og godt samarbeid. Ved å følge denne beste praksisen gjør De prosjektets historikk til en verdifull ressurs!
- Hold emnelinjene kortfattede og i imperativ.
- Bruk brødteksten til å forklare «hvorfor» en endring ble gjort.
- Vurder typeprefikser for kategorisering.
- Knytt meldinger til issues eller pull requests for å gi kontekst.
God committing!
Lær deg Profesjonell arbeidsflyt med Git og GitHub med en AI-veileder – gratis
Skriv og kjør ekte kode i nettleseren, få umiddelbar hjelp fra en AI-veileder som er tilgjengelig døgnet rundt, og fortsett der du slapp – på nettet eller i appen.
- Kurs
- 12
- Leksjoner
- 48
Ofte stilte spørsmål
Er leksjonen «Beste praksis for commit-meldinger» gratis?
Ja – hele teksten i «Beste praksis for commit-meldinger» er gratis å lese her på nettet. For å øve interaktivt med en innebygd kodeeditor og en AI-veileder som er tilgjengelig døgnet rundt, og for å låse opp resten av Profesjonell arbeidsflyt med Git og GitHub-kurset, kan du oppgradere til CoddyKit PRO. Kurset i Profesjonell arbeidsflyt med Git og GitHub inneholder totalt 4 leksjoner.
Hva lærer jeg i «Beste praksis for commit-meldinger»?
Ta i bruk konvensjoner for å skrive tydelige, konsise og informative commit-meldinger som gjør prosjektets historikk enklere å lese. Du øver på Profesjonell arbeidsflyt med Git og GitHub med praktisk kode som du kjører direkte i nettleseren, mens en AI-veileder som er tilgjengelig døgnet rundt, svarer på spørsmålene dine mens du jobber deg gjennom leksjonen.
Trenger jeg erfaring for å begynne med Profesjonell arbeidsflyt med Git og GitHub?
Ingen tidligere erfaring er nødvendig. Profesjonell arbeidsflyt med Git og GitHub på CoddyKit er lagt opp for både nybegynnere og viderekomne, så De kan begynne her eller helt fra start og lære i Deres eget tempo. Dette er leksjon 3 av 4.
Hvor lang tid tar leksjonen «Beste praksis for commit-meldinger»?
De fleste CoddyKit-leksjoner tar omtrent 5–10 minutter. Hver leksjon er kort og interaktiv, slik at De gjør jevne fremskritt og kan fortsette akkurat der De slapp – både på nettet og i appen.
Kan jeg skrive og kjøre kode i denne Profesjonell arbeidsflyt med Git og GitHub-leksjonen?
Ja. Alle Profesjonell arbeidsflyt med Git og GitHub-leksjoner har en innebygd kodeeditor, slik at De kan skrive og kjøre ekte kode direkte i nettleseren og få umiddelbar tilbakemelding fra AI – uten lokal konfigurering.
Alle leksjonene i dette kurset
- Sikre Git-arbeidsflyten din
- Håndtering av sensitive data (Git LFS)
- Beste praksis for commit-meldinger
- Signere commits og tagger med GPG