Pedoman umum untuk kontribusi projek ini, mengikuti pada pedoman yang berada pada link berikut.
Lihat ringkasan.
Pertama, buatlah fork repository ke akun kamu dengan menekan tombol fork di github.
Jika berhasil maka akan muncul repository hasil fork di akun kamu.
Setelah melakukan fork, clone repository hasil fork tadi ke komputer / laptop kamu.
$ git clone [email protected]:[username]/Arsip-WU.git
Ubah direktori / buka hasil clone menggunakan text editor, direkomendasikan menggunakan VSCode / VSCodium.
$ cd [path to dir]/Arsip-WU
$ codium . # membuka projek menggunakan vscodium
Ubah upstream agar menunjuk projek asli, sehingga kamu dapat mendapatkan kondisi salinan yang paling baru dari projek asli.
$ git remote add upstream [email protected]:divisi-security-poros/Arsip-WU.git
Sebelum menulis writeUP pastikan kamu telah memiliki salinan terbaru dari projek dengan menggunakan perintah
$ git pull upstream master && git push origin master
Selanjutnya, silahkan tulis WriteUP sesuai dengan nama kontes dan kategorinya pada branch master, atau membuat branch sendiri (optional). Jika belum tersedia, buat direktori / file tersebut. Format WriteUP disarankan menggunakan markdown berikut format file yang direkomendasikan.
Jika terdapat foto / gambar silahkan mengunggah di imgur atau google photos (tidak diperkenankan mengunggah langsung ke projek), untuk panduannya silahkan cari di search engine, di sini, atau di sini. Jangan Lakukan commit terlebih dahulu sebelum WriteUP yang kamu tulis benar-benar jadi dan ingin di-push pada projek asli, cukup melakukan operasi add terlebih daulu.
$ git add [something to add]
Sebelum melakukan PR, pastikan salinan projek merupakan salinan terbaru dengan mengetik,
$ git pull upstream master
Lalu, lakukan commit baru pada salinan projek dan lakukan push ke repositori github.
$ git commit -m "[Tulis Sesuatu Disini]"
$ git push -u origin master # ubah master menjadi branch lain jika kamu membuat branch baru
Setelah berhasil melakukan push, silahkan membuka PR baru pada laman repositori kamu (hasil fork) akan muncul tombol compare & pull request.
Tulis judul dan deskripsi yang sesuai pada PR dan klik tombol Create pull request.
Tunggu maintainer melakukan review terhadap PR kamu. Jika di terima maka writeUP akan diperbarui. Jika tidak, maka terdapat beberapa alasan seperti salah format, ada hal yang tidak sesuai dengan panduan ini, atau terdapat saran terhadap PR kamu agar menjadi lebih baik.
- Lakukan Fork dan Clone repositori
- Set upstream salinan lokal dan perbarui salinan lokal.
- Edit writeUP di-branch master atau membuat yang baru.
- Sebelum commit dan push, pastikan salinan lokal merupakan versi terbaru.
- Lakukan commit dan push.
- Buka PR baru.
- Tunggu maintainer melakukan review, periksa secara berkala dan jika ada revisi harap diperbaiki.