Dasar-dasar kontribusi untuk Microsoft Learn
Ada beberapa istilah yang perlu diketahui yang akan membantu Anda memahami dan menyelesaikan proses kontribusi. Tidak perlu mengetahui semua yang terjadi di bawah tenda, tetapi gambaran umum tentang cara kerja kontribusi membantu Anda memahami mengapa proses bekerja seperti yang dilakukannya.
Dasar-dasar Microsoft Learn dan GitHub
Microsoft Learn berisi ribuan artikel, modul pelatihan, halaman web, dan lainnya, yang perlu disimpan dan diakses secara teratur oleh berbagai kontributor. Microsoft Learn menggunakan GitHub untuk menyimpan sebagian besar konten ini. GitHub adalah platform yang menggunakan Git, sistem kontrol versi terdistribusi, untuk menyimpan proyek dan memfasilitasi kolaborasi di beberapa pemangku kepentingan dengan tujuan dan garis waktu proyek yang berbeda. Perangkat lunak Git dan GitHub memungkinkan Anda untuk bekerja secara paralel dengan kontributor lain pada proyek yang sama, berpotensi konten yang sama persis, bahkan pada saat yang sama, tanpa sengaja mengganggu pekerjaan orang lain.
Konten disimpan dalam file di repositori Git (repositori ) yang dihosting di GitHub. Repositori adalah unit penyimpanan yang berisi file proyek dan riwayat revisi file. Repositori dapat bersifat publik atau privat, dan Microsoft Learn terdiri dari campuran keduanya. Siapa pun dapat berkontribusi pada repositori publik setelah mereka menyiapkan akun GitHub. Repositori privat hanya tersedia untuk kontributor yang merupakan karyawan Microsoft atau yang telah diberi izin khusus.
Melakukan pengeditan pada konten Microsoft Learn yang disimpan di repositori GitHub
Untuk proyek apa pun, GitHub menghosting repositori utama dan fork apa pun. Fork adalah salinan repositori utama yang dilakukan kontributor untuk pekerjaan mereka sendiri. Fork adalah salah satu cara GitHub untuk melindungi konten yang diterbitkan. Alih-alih langsung mengedit konten di live, cabang repositori utama yang diterbitkan, GitHub mengambil rekam jepret konten tersebut untuk fork Anda, sehingga Anda dapat membuat perubahan di sana.
Repositori GitHub berisi satu atau beberapa cabang. Cabang adalah unit penyimpanan yang berisi file dan folder yang membentuk kumpulan konten proyek. Semua repositori, baik itu repositori utama atau fork, berisi cabang default (biasanya bernama "utama") dan satu atau beberapa cabang yang ditujukan untuk digabungkan kembali ke cabang default. Cabang default berfungsi sebagai versi saat ini dan "sumber kebenaran tunggal" untuk proyek. Ini adalah induk dari mana semua cabang lain di repositori dibuat.
Mengedit artikel dokumentasi di repositori publik mungkin tampak seperti dimulai dengan sentuhan tombol, tetapi ada beberapa hal yang terjadi di belakang layar. Saat Anda memulai proses pengeditan berbasis browser, fork repositori dibuat (jika Anda belum memilikinya) dan digunakan untuk perubahan Anda. Anda mengedit dalam cabang fork Anda, yang nantinya akan digabungkan ke cabang langsung repositori utama sehingga perubahan Anda tersedia untuk semua.
Membuat permintaan pull
Bagaimana penggabungan ini terjadi? Anda perlu memberi tahu GitHub - secara khusus, pemilik repositori utama dan penulis artikel - bahwa pengeditan Anda diselesaikan dan siap untuk ditinjau, diterbitkan, dan dunia untuk dilihat! Untuk melakukan ini, Anda membuat dan mengirimkan permintaan pull.
Permintaan pull (PR) adalah proposal agar perubahan Anda digabungkan dari cabang di fork anda yang sedang Anda kerjakan ke cabang default "utama" dari repositori langsung. Saat Anda bekerja di repositori publik, permintaan pull Anda akan selalu ditinjau oleh peninjau manusia sebelum digabungkan. Mungkin juga ada beberapa pemeriksaan otomatis, seperti kompatibilitas penggabungan dan validasi build. Setelah tinjauan ini selesai dan masalah apa pun diselesaikan, perubahan Anda akan digabungkan ke cabang langsung dan tersedia di Microsoft Learn!
Alur kerja untuk kontribusi kecil pada dokumentasi
Singkatnya, Anda akan mengikuti langkah-langkah umum ini saat membuat perubahan kecil pada dokumentasi Microsoft menggunakan editor web di GitHub:
- Saat Anda membuka file di browser untuk diedit, fork repositori publik secara otomatis dibuat untuk Anda. Cabang di fork Anda juga dibuat, sering disebut cabang patch.
- Buat perubahan Anda pada file.
- Buat permintaan pull untuk mengusulkan agar perubahan Anda ditinjau dan digabungkan.
- PR Anda harus menyelesaikan masalah apa pun dan meneruskan semua ulasan.
- PR Anda digabungkan ke cabang utama repositori langsung dan perubahan Anda diterbitkan di Microsoft Learn.
Selanjutnya, mari kita lihat setiap langkah lebih dekat untuk mempelajari cara melakukannya.