Növelje Github hírnevét a megfelelő Commit üzenetekkel

Ahelyett, hogy egysoros git üzeneteket írna, végezzen üzeneteket a elkövetni -m opció, ebben a cikkben megtanulhatja, hogyan írjon megfelelő véglegesítési üzeneteket. A megfelelő elkötelező üzenetek fontosak, mivel lehetővé teszik, hogy mások pontosan lássák, mit módosítottál, megkönnyítve a projekt követését mások számára, növelve a nyílt forráskódnak való kitettségét közösség.

Írjon egy megfelelő Commit üzenetet

Ahelyett, hogy a véglegesítési üzenetet belefoglalná a terminál parancsba, nyissa meg a kedvencét szöveg szerkesztő egy üres fájlba. Az üzenetnek meg kell felelnie a következő formátumnak:

• Az első sor a cím, amely összefoglalja a teljes elkötelezettséget.
instagram viewer
• Üres sort követve a következő sornak vagy több sornak az olvasható leírásnak kell lennie, ami szükséges az elkövetéshez. Ez addig tarthat, amíg kívánatos.
• Az összes következő sornak összefoglalnia kell a kód pontos módosításait ilyen formátumban:
  • Fájlnév: # sor - A módosítás rövid leírása.

Példa kötelezettségvállalási üzenetre

Az alábbiakban bemutatunk egy példát az elkövetési üzenetre:

Hozzáadott Docker támogatás, új is_unique funkció, valamint hibajavítás.
A dokkoló-írási támogatás és szükség esetén frissített telepítési utasítások támogatása. Tartalmazott egy új funkciót a check_order () függvényben, hogy ellenőrizze az egyediséget, és javított egy kis hibát a termékcsempék létrehozásakor.
src / somedir / library.py: 381 - Hozzáadta az 'is_unique' paramétert a check_order () függvényhez.
src / products.py: 194 - Javítva a hiba a termékcsiga létrehozásakor.
docker-compose.yml - Docker-compose fájl hozzáadása.
docs / install.md - Frissített telepítési útmutató, amely tartalmazza a telepítés módját a Dockeren keresztül.

Commit Message

A kötelezettségvállalás végrehajtása helyett a -m üzenetet használja a--fájl választási lehetőség. Például, ha az elkötelezett üzenet fájlneve Ent.txt, akkor futtatná a parancsot:

git kötelezettségszolgáltatás - fájl kötelezettség.txt

Ennyi van benne! Remélhetőleg ez segít szabványosítottabb és egyértelműbb elkötelezettséggel kapcsolatos üzenetek elküldésében követői számára, elősegítve a projekt expozícióját és a nyílt forráskód közösség növekszik.

Kép jóváírása: Caleb White /Unsplash