Cara mencari dan mengatur riwayat repositori dengan menggunakan GitHub

Di sini, kita akan membahas bagaimana Anda dapat menggunakan filter, menyalahkan, menautkan silang, label, tonggak pencapaian, balasan tersimpan, dan penugasan untuk mencari dan mengatur riwayat repositori.

Tempatkan diri Anda di posisi pengembang yang baru saja bergabung dengan proyek besar. Seseorang baru saja memposting masalah baru yang melaporkan bug yang terkait dengan bilah sisi aplikasi web, dan Anda telah ditetapkan untuk memperbaikinya. Anda telah membaca laporan beberapa kali dan memahami masalah yang dijelaskan, jadi sekarang Anda perlu mencari tahu cara memulai perbaikan.

Sebagai anggota tim baru, Anda belum terbiasa dengan basis kode. Anda juga belum menjadi bagian dari diskusi perencanaan, ulasan kode, atau hal lain yang akan memberi Anda konteks yang Anda butuhkan untuk memulai implementasi. Anda harus terlebih dahulu memperoleh pengetahuan latar belakang tersebut untuk menentukan perbaikan yang tepat dengan sebaik-baiknya.

Mencari GitHub

Meskipun Anda tidak ada untuk peristiwa yang menyebabkan implementasi bilah sisi, banyak dari peristiwa tersebut langsung dalam sejarah proyek. Mencari repositori proyek untuk "bilah sisi" akan memberi Anda titik awal.

Ada dua metode pencarian yang tersedia di GitHub: pencarian global di bagian atas halaman dan pencarian tercakup yang tersedia pada tab repositori tertentu. Mereka mendukung sintaks dan fungsi yang sama dengan cara yang sama, tetapi dengan beberapa perbedaan utama.

Pencarian Global

Pencarian global memungkinkan Anda menggunakan sintaks pencarian lengkap untuk mencari di semua GitHub.

Hasil pencariannya komprehensif dan mencakup segala sesuatu mulai dari kode hingga masalah hingga Marketplace (dan bahkan pengguna). Ini adalah cara terbaik untuk menemukan penyebutan istilah utama di beberapa jenis hasil dan repositori.

Dalam skenario kami, menggunakan pencarian global yang tercakup ke repositori saat ini adalah cara yang baik untuk menemukan kode dan penerapan yang menyebutkan istilah "bilah sisi". Anda juga mungkin akan mendapatkan temuan untuk masalah dan permintaan pull, meskipun tidak mudah untuk memfilter selengkapnya dalam tampilan hasil pencarian global.

Untuk membuat pencarian global yang kompleks, coba pencarian tingkat lanjut.

Pencarian konteks

Pencarian konteks tersedia di tab tertentu, seperti Masalah dan permintaan Pull. Pencarian ini dicakup ke dalam repositori saat ini dan hanya mengembalikan hasil dari jenis tersebut. Manfaat untuk cakupan ini adalah memungkinkan antarmuka pengguna untuk mengekspos filter khusus jenis yang diketahui seperti penulis, label, proyek, dan banyak lagi.

Menggunakan pencarian konteks adalah opsi yang disukai saat Anda mencari sesuatu di repositori saat ini. Dalam skenario kami, ini adalah cara yang baik untuk menemukan hasil pencarian yang menyebutkan "bilah samping", yang kemudian dapat Anda persempit dengan mudah menggunakan dropdown filter.

Menggunakan filter pencarian

Ada sejumlah cara tak terbatas untuk mencari menggunakan sintaks pencarian lengkap. Namun, sebagian besar pencarian hanya menggunakan beberapa filter umum. Meskipun ini sering tersedia dari menu dropdown pencarian konteks, terkadang lebih nyaman untuk mengetiknya secara langsung.

Berikut adalah beberapa contoh kueri filter:

Pelajari selengkapnya tentang Memahami sintaks pencarian

Menggunakan Tonggak Pencapaian

Tonggak pencapaian memungkinkan Anda mengelompokkan masalah dan menarik permintaan ke tujuan bersama, seperti sprint, rilis produk, atau fase proyek. Mereka membantu tim melacak kemajuan dan membuat semua orang selaras.

• Tonggak pencapaian dapat dipesan (sama seperti proyek), sehingga memudahkan untuk mengatur prioritas dan memvisualisasikan tonggak mana yang paling penting.
• Kemajuan terhadap setiap tonggak pencapaian dilacak secara otomatis—GitHub menunjukkan berapa banyak masalah atau PR yang selesai dan berapa banyak yang tersisa.
• Tonggak pencapaian sangat berguna untuk melacak pekerjaan yang masuk ke rilis atau fase terpisah.

Membuat tonggak pencapaian

1. Navigasi ke tab Masalah di repositori Anda.
2. Pilih Pencapaian dari menu atas.
3. Klik Pencapaian baru.
4. Masukkan judul, deskripsi, dan secara opsional tanggal jatuh tempo.
5. Klik Buat pencapaian.

Menetapkan tonggak pencapaian ke masalah atau permintaan pull

1. Buka masalah atau PR apa pun.
2. Di bilah sisi kanan, pilih Tonggak Pencapaian.
3. Pilih dari daftar pencapaian yang tersedia.

Anda juga dapat menambahkan tonggak pencapaian sebagai kolom ke tata letak Proyek GitHub Anda atau menampilkan tonggak pencapaian sebagai kartu di papan Proyek GitHub. Ini membantu memvisualisasikan dan mengelola kemajuan tim Anda langsung dari papan perencanaan proyek Anda.

Anda dapat memfilter berdasarkan tonggak pencapaian di Proyek GitHub atau dengan kueri pencarian tingkat lanjut seperti:

is:open is:pr milestone:"Release v1.0"

Tonggak pencapaian paling baik saat digunakan secara konsisten di seluruh alur kerja perencanaan tim Anda.

Label dan Tonggak Pencapaian dalam Pencarian

Label dan tonggak pencapaian adalah alat metadata yang membantu tim mengatur masalah dan menarik permintaan. Mereka juga meningkatkan akurasi kueri pencarian.

Filter menurut label

Anda dapat mempersempit masalah dengan memfilter dengan label: kata kunci.

Contohnya:

is:open is:issue label:bug

Ini mengembalikan semua masalah terbuka yang diberi label sebagai "bug." Label dapat mencerminkan jenis masalah, prioritas, tim, atau status alur kerja.

is:pr label:"ready for review" author:@me

Filter menurut tonggak pencapaian

Tonggak pencapaian membantu Anda mengelompokkan masalah dan menarik permintaan terhadap rilis atau tujuan target. milestone: Gunakan kata kunci dalam kueri Anda untuk mengembalikan item dalam tonggak pencapaian tertentu.

Contohnya:

is:open is:issue milestone:"Sprint 1"

Apa yang disalahkan git?

Terlepas dari nama yang tidak penting, git blame adalah perintah yang menampilkan riwayat penerapan untuk file. Ini memudahkan Anda untuk melihat siapa yang membuat perubahan dan kapan. Ini membuatnya jauh lebih mudah untuk melacak orang lain yang telah mengerjakan file untuk mencari input atau partisipasi mereka.

Kesalahan dalam GitHub

GitHub memperluas fungsionalitas dasar git blame dengan antarmuka pengguna yang lebih kuat.

Dalam skenario kami, ada beberapa cara untuk mendapatkan tampilan ini. Anda mungkin telah menemukan beberapa kode bilah sisi dari pencarian global dan memilih opsi Salahkan untuk melihat siapa yang mengerjakannya terakhir, atau mungkin Anda menemukan permintaan pull dan melacaknya kembali ke penerapan terakhir yang tampaknya terkait dengan deskripsi bug. Namun Anda sampai di sini, pandangan menyalahkan adalah cara yang efektif untuk menemukan pakar subjek untuk tugas yang ditangani.

Masalah penautan silang, penerapan, dan lainnya

Bagian dari apa yang membuat GitHub bagus untuk proyek perangkat lunak kolaboratif adalah dukungannya untuk menghubungkan informasi yang berbeda bersama-sama. Beberapa dari ini terjadi secara otomatis, seperti ketika Anda membuat permintaan pull dari serangkaian penerapan pada cabang. Di lain waktu, Anda dapat menggunakan antarmuka untuk menautkan permintaan pull atau proyek secara manual ke masalah menggunakan opsi dropdown.

Balasan tersimpan

Balasan tersimpan memungkinkan Anda merespons masalah dengan cepat dan menarik permintaan dengan pesan yang telah ditulis sebelumnya. Mereka sangat membantu bagi pelaksana proyek yang sering memberikan umpan balik atau instruksi yang sama.

Membuat atau mengedit balasan tersimpan

1. Klik foto profil Anda di sudut kanan atas dan pilih Pengaturan.
2. Di bilah sisi kiri, klik Balasan tersimpan.
3. Pilih Balasan tersimpan baru.
4. Masukkan judul dan pesan Anda.
5. Klik Simpan balasan.

Untuk mengedit atau menghapus balasan tersimpan, kembali ke pengaturan Balasan tersimpan dan gunakan opsi di samping masing-masing.

Menggunakan balasan tersimpan

Saat menulis komentar tentang masalah atau permintaan pull, Anda dapat menyisipkan balasan yang disimpan:

1. Klik kotak komentar.
2. Pilih ikon Sisipkan balasan yang disimpan (gelembung ucapan dengan baris).
3. Pilih balasan tersimpan dari daftar.
4. Ubah teks jika diperlukan, lalu klik Komentar.

Balasan tersimpan menghemat waktu dan membantu memastikan konsistensi saat merespons di seluruh proyek Anda.

Berikut adalah versi terbaru yang menyertakan panduan tentang templat masalah—menjelaskan apa itu, perbedaannya dengan balasan yang disimpan, dan mengapa biasanya lebih baik untuk mengumpulkan informasi terstruktur di muka.

Templat Masalah

Meskipun balasan yang disimpan berguna untuk respons umum, templat masalah adalah cara yang lebih baik untuk memastikan kontributor memberikan semua informasi yang diperlukan saat membuat masalah baru.

• Templat masalah meminta pengguna untuk mengisi bidang tertentu atau menjawab pertanyaan tertentu di muka, mengurangi bolak-balik dan memastikan Anda memiliki detail yang Anda butuhkan sejak awal.
• Templat membantu pemeliharaan menghindari "data yang hilang" dengan mengumpulkan informasi terstruktur sebelum masalah bahkan dikirimkan.

Praktik terbaik: Gunakan templat masalah untuk menangkap detail yang diperlukan dan mengurangi informasi yang hilang atau tidak lengkap. Gunakan balasan tersimpan untuk respons dan instruksi rutin setelah masalah atau permintaan pull dikirimkan.

Menambahkan penerima tugas

Anda dapat menetapkan satu atau beberapa orang ke masalah atau menarik permintaan untuk menunjukkan siapa yang bertanggung jawab untuk mengerjakannya.

Menambahkan penerima tugas

1. Buka masalah atau permintaan pull.
2. Di bilah sisi kanan, klik Penerima tugas.
3. Pilih satu atau beberapa pengguna dari menu dropdown.

Anda juga dapat menetapkan orang langsung dari tampilan daftar menggunakan kotak centang di samping setiap masalah dan memilih Tetapkan dari bilah atas.

Contoh:

is:open is:issue assignee:@me

Referensi yang ditautkan otomatis

Untuk membuatnya lebih mudah untuk menautkan silang item yang berbeda di seluruh proyek Anda, GitHub menawarkan sintaks singkat. Misalnya, jika Anda meninggalkan komentar seperti Duplicate of #8, GitHub akan mengenali bahwa #8 adalah masalah dan membuat tautan yang sesuai untuk Anda.

GitHub juga menautkan penerapan untuk Anda jika Anda menempelkan tujuh karakter pertama atau lebih dari ID-nya.

Dalam skenario kami, tautan ini dapat terbukti sangat berharga untuk meningkatkan jika seseorang berpikir ke depan untuk meninggalkan konteks. Misalnya, status bilah sisi saat ini mungkin memiliki beberapa masalah umum yang terkait dengan dependensi JavaScript. Jika masalah dengan dependensi tersebut dibahas dalam masalah lain yang tidak secara eksplisit menyebutkan "bilah sisi", maka akan sulit untuk ditemukan. Namun, jika seseorang telah berpikir ke depan untuk menautkan masalah dalam diskusi, maka itu bisa menghemat banyak waktu Anda sekarang. Ingatlah hal itu saat Anda mendanai masalah dan permintaan pull di lain waktu.

Pelajari selengkapnya tentang Referensi dan URL yang ditautkan otomatis.

Perulangan di pengguna dengan @mention

Selain menautkan masalah dan penerapan, seringkali bermanfaat untuk mengaitkan orang lain dengan diskusi. Cara termudah untuk melakukan ini adalah dengan menggunakan @mention. Penyebutan semacam ini memberi tahu pengguna yang disebutkan sehingga mereka dapat berpartisipasi dalam diskusi. Ini juga merupakan cara yang baik untuk mengidentifikasi orang-orang yang terkait dengan masalah lama setelah ditutup.