Embedded Files
Projekte on kergem haldada, kui on kerge mõista Sinu poolt kirjutatud commit sõnumeid. Saame kergesti leida näiteks mõne veakoha kasvõi aastate pärast.
Commit sõnumeid kirjutades soovitatakse jälgida järgmiseid stiilireegleid:
Esimene rida annab lühisõnaliselt commit-i muudatustest teada pealkirja kujul, käskivas kõneviisis (max 50 tähemärki). Ära lõpeta pealkirja punktiga.
Juhul, kui on vaja rohkem seletust, jäta pealkirja vahele tühi rida, ning kirjuta sellest järgmisele reale pikem seletus. Seleta täpsemalt, mida muudeti ning miks, ja millised tagajärjed võivad selle muudatusega kaasa tulla. Kirjuta ühele reale ligikaudu 72 tähemärki, kui läheb üle, jätka järgmisel real. Lõike saad eraldada tühja reaga.
Lisaks, kui antud commit lahendab mingit Issue-t, lisa ka sellele link või selle ID.
HEA NÄIDE.
More detailed explanatory text, if necessary. Wrap it to about 72characters or so. In some contexts, the first line is treated as thesubject of the commit and the rest of the text as the body. Theblank line separating the summary from the body is critical (unlessyou omit the body entirely); various tools like `log`, `shortlog`and `rebase` can get confused if you run the two together.
Explain the problem that this commit is solving. Focus on why youare making this change as opposed to how (the code explains that).Are there side effects or other unintuitive consequences of thischange? Here's the place to explain them.
Further paragraphs come after blank lines.
- Bullet points are okay, too
- Typically a hyphen or asterisk is used for the bullet, preceded by a single space, with blank lines in between, but conventions vary here
If you use an issue tracker, put references to them at the bottom,like this:
Resolves: #123See also: #456, #789
HALB NÄIDE.
Siin on teatud kasutaja korduvalt jätnud commitid seletamata – kirjutanud vaid, millise failiga ta tegeleb.
Page updated
Google Sites
Report abuse