Kihagyás

Commit

1. Elnevezési konvenció

A commit messageket angol felszólító módban kell írni és minden esetben a JIRA ticket id-val kell kezdődniük.

A helyes formátum így írható le:

{ProjektNévAcronym}-{TicketID} {A változtatás angol felszólító módban megfogalmazott rövid összefoglalása}
Ahol:

  • A {ProjektNévAcronym} : Csak az angol ábécében megtalálható nagybetűkből állhat.
  • A {TicketID} : Kizárólag számokat tartalmazhat.
  • A {ProjektNévAcronym}-ot a {TicketID}-tól egy - karakter választja el.
  • Az {TicketID} a szövegezést egy szóköz karakter választja el.

Helyes példa: 

SEMI-1 Add calculation feature

Helytelen példák: 

Semi-1 Add calculation feature
SEMI1 Add calculation feature
SEMI 1 Add calculation feature
SEMI-1Add calculation feature
SEMI-1 add calculation feature
SEMI-1 Calculation feature

Több soros commit message-ek

Habár a Git megengedi a többsoros commit message-eket, azonban a projekten nem szabad több soros commit message-eket írni!

Ennek oka, hogy gyakorta használjuk a GitLab squash funkcióját, azonban több soros commit messagek esetén ez a funkció rosszul működik.

Milyen a jó commit message?

A commit message-ekről általánosságban itt olvashattok.

2. Commitolási szabályok

Alapvetően mindig törekedjünk arra, hogy fejlesztés közben gyakran, de legalább minden nap végén commitoljunk, amit fel is pusholunk a remote branch-re.

Továbbá figyeljünk arra, hogy amennyiben nem squasholunk lokálisan, úgy a GitLab fogja elvégezni ezt helyettünk és automatikusan választja meg ehhez a commit message-et. Éppen ezért, amikor commit message-et írunk, fontos szem előtt tartanunk, hogy

  • amennyiben a branchünkön csak 1 commit van, úgy annak a commit message-je lesz a GitLab által választott squasholt commit message.
  • amennyiben a branchünkön több commit van, úgy a merge request title lesz a GitLab által választott squasholt commit message.