Tingkatkan Reputasi Github Anda dengan Pesan Komit yang Tepat

Alih-alih menulis pesan komit satu baris dengan ekstensi komit -m opsi, dalam artikel ini pelajari cara menulis pesan komit yang tepat. Pesan komit yang tepat itu penting, karena memungkinkan orang lain untuk melihat dengan tepat apa yang telah Anda ubah, membuat proyek Anda lebih mudah untuk diikuti orang lain membantu meningkatkan eksposur Anda ke open source masyarakat.

Tulis Pesan Komit yang Benar

Alih-alih menyertakan pesan komit di perintah terminal, buka favorit Anda editor teks ke file kosong. Pesan tersebut harus sesuai dengan format berikut:

• Baris pertama adalah judul, meringkas seluruh komit.
• Mengikuti baris kosong, baris berikutnya atau beberapa baris harus berupa deskripsi yang dapat dibaca yang diperlukan untuk komit. Ini mungkin selama yang diinginkan.
  instagram viewer
• Semua baris berikut harus meringkas perubahan persis yang dilakukan pada kode dalam format seperti itu:
  • Nama file: Baris # - Deskripsi singkat tentang modifikasi.

Contoh Pesan Komit

Di bawah ini menunjukkan contoh pesan komit:

Menambahkan dukungan Docker, fitur is_unique baru, plus perbaikan bug.
Menambahkan dukungan untuk penulisan galangan dan instruksi penginstalan yang diperbarui sesuai kebutuhan. Juga disertakan fitur baru dalam fungsi check_order () untuk memeriksa keunikan, dan memperbaiki bug kecil saat membuat produk siput.
src / somedir / library.py: 381 - Menambahkan parameter 'is_unique' ke fungsi check_order ().
src / products.py: 194 - Memperbaiki bug saat membuat product slug.
docker-compose.yml - Menambahkan file docker-compose.
docs / install.md - Panduan instalasi yang diperbarui untuk menyertakan cara menginstal melalui Docker.

Pesan Komit

Saat membuat komit sekarang, alih-alih menggunakan -m pesan, gunakan--mengajukan pilihan. Misalnya, jika nama file dari pesan commit Anda adalah commit.txt Anda akan menjalankan perintah:

git commit --file commit.txt

Hanya itu yang ada untuk itu! Semoga ini membantu Anda memberikan pesan komitmen yang lebih terstandardisasi dan jelas kepada pengikut Anda, membantu proyek Anda mendapatkan eksposur, dan membantu sumber terbuka komunitas tumbuh.

Kredit Gambar: Caleb White /Unsplash