Bagaimana cara menyiapkan dan mengunggah proyek yang sudah ada ke GitHub?
Di unit ini, kita membahas pertimbangan penting untuk mengunggah proyek ke GitHub.
Mengapa mengunggahnya ke GitHub?
Ada volume literatur yang mengekstop kebajikan GitHub, dan berada di luar cakupan modul ini untuk meyakinkan Anda untuk bergabung. Namun, dalam modul ini kami merekap beberapa manfaat utama dalam konteks subjek yang perlu Anda pertimbangkan saat merencanakan unggahan Anda.
Kontrol versi
GitHub secara eksklusif menggunakan Git, bisa dibilang sistem kontrol versi terbaik di sekitarnya. Namun, Git sangat canggih dan dapat membuat beberapa skenario kompleks untuk bekerja dengan kode yang mungkin tidak dialami tim Anda. Cabang dan permintaan pull adalah bagian mendasar dari keseharian pengembang yang menggunakan Git. Jadi memahami kapan dan bagaimana menggunakannya secara efektif adalah hal wajib agar berhasil pada GitHub. Sebaiknya tim Anda terlebih dahulu memahami aliran GitHub sehingga Anda dapat mulai bekerja.
Menyimpan kode Anda di cloud
Sejumlah besar kode proyek masih disimpan secara eksklusif di mesin pengembang. Saat mengunggah ke GitHub, Anda memindahkan kode Anda ke platform cloud GitHub, tempat anggota tim dapat dengan mudah mengaksesnya dari mana saja. Perubahan ini menawarkan peluang baik untuk meninjau kebijakan tim Anda terhadap jenis file dan data yang Anda simpan dalam kontrol versi. Sebagai praktik terbaik, Anda harus berasumsi bahwa apa pun yang Anda berkomitmen pada GitHub berpotensi disusupi. Jadi, pastikan untuk tidak menyertakan data sensitif, seperti kunci API, kata sandi, atau file lain yang berisi informasi yang sebanding.
Catatan
GitHub menawarkan repositori publik dan privat, serta kontrol akses terperinci untuk berbagai bagian repositori. Ini memungkinkan Anda mengontrol kepada siapa proyek Anda terlihat, serta tindakan apa yang dapat dilakukan pengguna tertentu.
Kolaborasi
GitHub menawarkan dukungan yang sangat baik untuk kolaborasi tim melalui fitur seperti masalah, permintaan pull, dan peninjauan kode. Namun, alur GitHub mungkin berbeda dari praktik yang saat ini terbiasa dengan tim Anda. Ada baiknya untuk mempertimbangkan bagaimana tim Anda dapat beradaptasi dengan GitHub, dan apakah Anda harus mempertahankan proses yang ada atau tidak.
Jika proyek Anda adalah proyek sumber terbuka yang mengizinkan kontributor luar, tidak ada opsi yang lebih baik daripada GitHub untuk memaksimalkan manfaatnya.
Unggah ke GitHub
Pertimbangan rencana
Hal terpenting yang perlu dipertimbangkan sebelum mengeksekusi pengunggahan Anda ke GitHub adalah apakah Anda perlu mempertahankan hal lain di luar status sumber Anda saat ini. Misalnya, Anda dapat menggunakan spreadsheet atau perangkat lunak manajemen proyek untuk melacak bug yang anda rencanakan untuk diperbaiki. Dukungan untuk memigrasikan item ini bervariasi menurut platform, dan umumnya tersedia dari proyek komunitas. Modul ini tidak mencakup migrasi jenis data tersebut.
Menangani file biner yang saat ini disimpan di proyek Anda
Sebagai praktik terbaik, repositori GitHub harus dibatasi pada file yang diperlukan untuk membangun proyek. Hindari menerapkan file biner besar, seperti artefak build. File biner seperti spreadsheet dan presentasi lebih cocok untuk dilacak di portal yang memahami cara menyajikan dan membuat versinya dengan benar. Jika Anda harus membuat versi file biner besar, pertimbangkan penggunaan ekstensi Git LFS (Large File Storage).
Membuat file Git penting seperti .gitignore
Git mendukung file .gitignore untuk membantu menerapkan kebijakan file kontrol versi. File-file ini menentukan pola pencarian yang digunakan untuk mengecualikan file dan folder dari pelacakan kontrol sumber. Contoh berikut secara rekursif mengecualikan folder apa pun yang disebut Bin atau bin, dan kontennya, dari pelacakan kontrol sumber.
[Bb]in/
Pelajari selengkapnya tentang Mengabaikan file. Lihat juga kumpulan file .gitignore pemula yang ditawarkan untuk berbagai platform di repositori gitignore.
Ada beberapa file lain yang umum digunakan dalam proyek GitHub untuk menjelaskan berbagai kebijakan kepada konsumen dan kontributor repositori. Bahkan jika bersifat privat dan terbatas untuk audiens tertentu, proyek Anda masih bisa digunakan untuk mengartikulasi kebijakan berikut secara eksplisit. Meskipun tidak ada file-file ini yang diperlukan, beberapa file umum dicantumkan di sini.
| File | Tujuan |
|---|---|
README.md |
Halaman arahan untuk direktori. Halaman ini dirender saat direktorinya ditampilkan di GitHub. |
LICENSE.md |
File ini berisi lisensi tempat kode disediakan. |
CONTRIBUTING.md |
Jelaskan cara pengguna berkontribusi pada proyek, seperti ekspektasi permintaan pull. |
SECURITY.md |
Menjelaskan kebijakan keamanan untuk proyek. File ini memberikan panduan kepada pengguna yang ingin mengirimkan kode atau umpan balik terkait keamanan sensitif yang tidak boleh diungkapkan secara publik sebelum ditangani. |
Pelajari selengkapnya tentang Menyiapkan proyek Anda untuk kontribusi yang bermanfaat.
Unggah proyek Anda ke GitHub
Setelah repositori Anda disiapkan untuk diunggah, buat repositori di GitHub. Setelah dibuat, buka tab Kode di repositori GitHub Anda. Tampilan ini memberi Anda beberapa cara untuk mengunggah kode proyek Anda.
Kami menyarankan agar Anda menggunakan klien git atau alat ramah Git untuk mengunggah sumber Anda. Atau, Anda dapat mengunggah file secara manual menggunakan tautan membuat file baru. Selama jangka panjang, Anda mungkin menemukan bahwa menggunakan klien git adalah cara terbaik untuk mengelola perubahan, cabang, dan banyak lagi.