Norite pagerinti savo reputaciją „GitHub“? Štai kaip suformatuoti įsipareigojimo pranešimus.
Užuot rašę vienos eilutės „git“, praneškite su įsipareigoti -m Šiame straipsnyje sužinokite, kaip rašyti tinkamus pranešimus apie įsipareigojimą. Tinkamas įsipareigojimo pranešimas yra svarbus, nes jis leidžia kitiems pamatyti, ką tiksliai modifikavote, palengvinsite jūsų projekto stebėjimą kitiems, padėsite padidinti atvirojo kodo poveikį bendruomenė.
Parašykite tinkamą įsipareigojimo pranešimą
Užuot įtraukę įsipareigojimo pranešimą į terminalo komandą, atidarykite savo mėgstamiausią teksto redaktorius į tuščią bylą. Pranešimas turi atitikti šį formatą:
Ieškote „Linux“ terminalo teksto redaktoriaus? Pagrindinis pasirinkimas yra tarp „Vim“ ir „nano“! Štai kaip jie lygina.
- Pirmoji eilutė yra pavadinimas, apibendrinantis visą įsipareigojimą.
- Po tuščios eilutės kita eilutė arba kelios eilutės turėtų būti bet koks skaitomas aprašymas, reikalingas įsipareigojimui. Tai gali būti tiek laiko, kiek norisi.
- Visos šios eilutės turėtų apibendrinti tikslius kodo pakeitimus tokiu formatu:
- Failo pavadinimas: eilutė # - trumpas pakeitimo aprašymas.
Įsipareigojimo pranešimo pavyzdys
Žemiau pateikiamas įsipareigojimo pranešimo pavyzdys:
Pridėtas „Docker“ palaikymas, nauja „is_unique“ funkcija ir klaidų taisymas.
Prireikus pridėta doko kūrimo ir atnaujintų diegimo instrukcijų palaikymas. Taip pat įtraukė naują funkciją „check_order ()“ funkcija, siekiant patikrinti unikalumą, ir ištaisė nedidelę klaidą kuriant produkto šliužus.
src / somedir / library.py: 381 - Pridedamas parametras „is_unique“ prie funkcijos check_order ().
src / products.py: 194 - Ištaisyta klaida kuriant produkto šliužą.
docker-compose.yml - pridėtas „docker-compose“ failas.
docs / install.md - atnaujintas diegimo vadovas, kuriame nurodoma, kaip įdiegti per „Docker“.
Įvykdyti pranešimą
Priimdami įsipareigojimą dabar, užuot naudoję -m pranešimą, naudokite--failas variantą. Pvz., Jei jūsų įsipareigojimo pranešimo failo vardas yra įsipareigojimas.txt, paleisite komandą:
git įsipareigoti - failas įsipareigoti.txtTai viskas, ką gali! Tikimės, kad tai padės jums pateikti daugiau standartizuotų ir aiškių pranešimų apie savo sekėjus, padės jūsų projektui parodyti ir padės atviro kodo bendruomenė auga.
Vaizdo kreditas: Caleb White /Nenuplėšti
Norite pasidalinti savo plėtros projektais internete? Štai kaip pradėti naudoti savo pirmąją „Github“ saugyklą.
- Programavimas
- „GitHub“
Prenumeruokite mūsų naujienlaiškį
Prisijunkite prie mūsų naujienlaiškio, kuriame rasite techninių patarimų, apžvalgų, nemokamų el. Knygų ir išskirtinių pasiūlymų!
Dar vienas žingsnis…!
Prašome patvirtinti savo el. Pašto adresą el. Laiške, kurį jums ką tik išsiuntėme.