Palieliniet savu Github reputāciju, izmantojot pareizus apņemšanās ziņojumus

Tā vietā, lai rakstītu vienas rindas git, veiciet ziņojumus ar apņemties -m opcija, šajā rakstā uzziniet, kā rakstīt pareizus saistību ziņojumus. Pareiza apņemšanās ziņa ir svarīga, jo tā ļauj citiem redzēt tieši to, ko esat modificējis, padarot jūsu projektu vieglāk sekojamu citiem, palīdzot palielināt atklātā pirmkoda pieejamību kopiena.

Uzrakstiet pareizu apņemšanās ziņojumu

Tā vietā, lai termināļa komandā būtu iekļauts ziņojums par apņemšanos, atveriet savu iecienītāko teksta redaktors uz tukšu failu. Ziņojumam jāatbilst šādam formātam:

• Pirmā rinda ir nosaukums, kas apkopo visu apņemšanos.
• Pēc tukšas rindas nākamajai vai vairākām rindām jābūt jebkuram lasāmam aprakstam, kas nepieciešams saistībai. Tas var būt tik ilgi, cik vēlaties.
  instagram viewer
• Visās turpmākajās rindās ir jāapkopo precīzas koda izmaiņas šādā formātā:
  • Faila nosaukums: Line # - Īss modifikācijas apraksts.

Saistības ziņojuma piemērs

Zemāk parādīts apņemšanās ziņojuma piemērs:

Pievienots Docker atbalsts, jauna is_unique funkcija, kā arī kļūdu labojums.
Ja nepieciešams, pievienots dokstatora sastādīšanas un atjauninātu instalēšanas instrukciju atbalsts. Iekļāva arī jaunu funkciju check_order () funkcijā, lai pārbaudītu unikalitāti, un izlaboja nelielu kļūdu, veidojot produkta lodes.
src / somedir / library.py: 381 - Funkcijai check_order () pievienots parametrs 'is_unique'.
src / products.py: 194 - Izlabota kļūda, veidojot produkta plēvi.
docker-compose.yml - pievienots dokstacijas sastādīšanas fails.
docs / install.md - Atjaunināta instalēšanas rokasgrāmata, iekļaujot tajā instalēšanu, izmantojot Docker.

Izpildīt ziņojumu

Veicot apņemšanos tagad, tā vietā, lai izmantotu -m izmantojiet--fails opcija. Piemēram, ja jūsu apņemšanās ziņojuma faila nosaukums ir pühend.txt, palaidiet komandu:

git saistīt - fails fail.txt

Tas viss ir pie tā! Cerams, ka tas palīdz jums sniegt standartizētākus un skaidrākus ziņojumus saviem sekotājiem, palīdzot jūsu projektam iegūt lielāku uzmanību un palīdzēt atvērtais avots sabiedrība augt.

Attēlu kredīts: Caleb White /Atvienot