Sisuline töö – üldised soovitused

< All Topics
Print

Sisuline töö – üldised soovitused

Oluline

Eelnevates peatükkides vaatlesime git repositooriumi loomist ning projekti allalaetud failide lisamist repositooriumisse. 

Siit alates hakkab sisuline töö CV projektiga, mille lõpp tulemuseks on soovi korral avalikult vaadatav isiklik CV leht GitHub pages keskkonnas.

git add , git commit - soovitused

Copy the URL link to this section to share

Soovitused refereeritud artiklist

  • Hoia commit'ed võimalikult väikesed

    Git käsitleb commit ühe tervikuna. Kui on hiljem vaja midagi tagasi pöörata, on väiksemat hulka faile mõjutava commit puhul lihtsam.

  • Liida commit'i ühe teemaga seotud muudatused

    Võimaldab hiljem ajaloost vaadata, mis ajal, mis muudatus on täpselt tehtud ning võimaldab commit sõnumi hoida lühikese.

git commit - sõnumi (message) kirjutamise reeglid

Copy the URL link to this section to share

  • Kirjuta sisuliselt

    Commit message - tegemist ei ole salakoodiga. Kirjuta, mida tegid, et ise ja ka teised saaksid hiljem aru, mida on tehtud ja miks.

  • Hoia commit sõnum lühike

    git commit -m "kuni 50 tähemärki". On võimalik kirjutada ka pikemaid sõnumeid, kasutades seotud tekstitoimetit //TODO

  • KONTROLLI! Kasuta kirjutamisel olevikku

    Vajab tähelepanu. See tuleneb otseselt Inglise keelsest soovitusest ning ma ei ole kindel, et see Eesti keele jaoks on õige.

  • Sõnumis viita Miks sa midagi tegid

    Viita miks sa muudatuse/lisamise tegid. Arusaamine, miks tehtud muudatus tegi projekti paremaks, annab nii teistele, kui endale rohkem.

  • Kontrolli õigekirja

    Alusta suure tähega. Kasuta korrektseid kirjavahemärke.

  • Kontrolli kas sõnum on sisuliselt korrektne

    Korrektne vigade vaba sõnum näeb hea välja. Git ajalugu on oluliselt lihtsam lugeda.

Table of Contents