Αυξήστε τη φήμη του Github με σωστά μηνύματα Commit

Αντί να γράφετε μια γραμμή git δεσμεύστε μηνύματα με το δεσμεύω -μ επιλογή, σε αυτό το άρθρο μάθετε πώς να γράφετε κατάλληλα μηνύματα δέσμευσης. Ένα σωστό μήνυμα δέσμευσης είναι σημαντικό, καθώς επιτρέπει σε άλλους να βλέπουν ακριβώς τι έχετε τροποποιήσει, διευκολύνοντας την παρακολούθηση του έργου σας, βοηθώντας στην αύξηση της έκθεσής σας στον ανοιχτό κώδικα κοινότητα.

Γράψτε ένα σωστό μήνυμα δέσμευσης

Αντί να συμπεριλάβετε το μήνυμα δέσμευσης στην εντολή τερματικού, ανοίξτε το αγαπημένο σας επεξεργαστής κειμένου σε ένα κενό αρχείο. Το μήνυμα πρέπει να συμμορφώνεται με την ακόλουθη μορφή:

• Η πρώτη γραμμή είναι ο τίτλος, συνοψίζοντας ολόκληρη τη δέσμευση.
instagram viewer
• Μετά από μια κενή γραμμή, η επόμενη γραμμή ή πολλές γραμμές θα πρέπει να είναι οποιαδήποτε αναγνώσιμη περιγραφή απαραίτητη για τη δέσμευση. Αυτό μπορεί να είναι όσο επιθυμείτε.
• Όλες οι ακόλουθες γραμμές πρέπει να συνοψίζουν τις ακριβείς αλλαγές που έγιναν στον κώδικα σε τέτοια μορφή:
  • Όνομα αρχείου: Γραμμή # - Σύντομη περιγραφή της τροποποίησης.

Παράδειγμα δέσμευσης μηνύματος

Παρακάτω εμφανίζεται ένα παράδειγμα μηνύματος δέσμευσης:

Προστέθηκε υποστήριξη Docker, νέα λειτουργία is_unique, καθώς και διόρθωση σφαλμάτων.
Προστέθηκε υποστήριξη για οδηγίες σύνταξης και ενημέρωσης εγκατάστασης, όπως απαιτείται. Περιέλαβε επίσης μια νέα λειτουργία στη λειτουργία check_order () για έλεγχο της μοναδικότητας και διόρθωση μικρού σφάλματος κατά τη δημιουργία γυμνοσάλιαγκων προϊόντων.
src / somedir / library.py: 381 - Προστέθηκε η παράμετρος "is_unique" στη συνάρτηση check_order ().
src / products.py: 194 - Διορθώθηκε το σφάλμα κατά τη δημιουργία slug προϊόντος.
docker-compose.yml - Προστέθηκε αρχείο σύνθεσης docker.
docs / install.md - Ενημερωμένος οδηγός εγκατάστασης για τον τρόπο εγκατάστασης μέσω του Docker.

Δέσμευση μηνύματος

Όταν κάνετε μια δέσμευση τώρα, αντί να χρησιμοποιήσετε το -Μ μήνυμα, χρησιμοποιήστε το--αρχείο επιλογή. Για παράδειγμα, εάν το όνομα αρχείου του μηνύματος δέσμευσης είναι commit.txt, θα εκτελέσετε την εντολή:

git commit - αρχείο commit.txt

Αυτό είναι το μόνο που υπάρχει! Ας ελπίσουμε ότι αυτό θα σας βοηθήσει να παρέχετε πιο τυποποιημένα και σαφή μηνύματα δέσμευσης στους οπαδούς σας, βοηθώντας το έργο σας να αποκτήσει έκθεση και να βοηθήσει ανοιχτή πηγή η κοινότητα μεγαλώνει.

Πιστωτική εικόνα: Caleb White /Απεμπλοκή