From 80ccdbdb368d3b22cc308895600395f603657232 Mon Sep 17 00:00:00 2001 From: Farrel Augusta Dinata Date: Wed, 11 Dec 2024 18:18:20 +0700 Subject: [PATCH] add contributing.md to guide any contributors --- CONTRIBUTING.md | 60 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 60 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..dc02dc4 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,60 @@ +# Panduan Kontribusi Proyek + +Kami dengan senang hati menyambut keinginan Anda untuk berkontribusi pada proyek ini. Segala bentuk kontribusi, baik berupa laporan bug, saran fitur, maupun pengajuan kode, akan kami apresiasi dan pertimbangkan demi pengembangan proyek yang lebih baik. + +Penulisan panduan ini terbagi ke dalam dua jenis, yaitu panduan untuk kontributor internal dan kontributor eksternal. +- [Panduan kontributor internal](#panduan-kontributor-internal) +- [Panduan kontributor eksternal](#panduan-kontributor-eksternal) + +--- + +## Panduan kontributor internal + +Kontributor internal adalah pihak yang dengan sengaja diundang untuk menggarap proyek ini. Berikut adalah beberapa panduan yang perlu dipatuhi oleh para kontributor internal: + +- Upaya kontribusi ke branch utama + 1. Kloning repositori ini ke komputer Anda + 2. Ganti branch sesuai dengan nama Anda. + + Saat ini sudah terdapat 5 branch dengan 3 role berbeda. + ``` + ui/dewita # berhubungan dengan tampilan antarmuka pengguna dan aset-aset yang akan dibutuhkan di dalam website + ui/fajar + db/afifah # berhubungan dengan skema basis data yang digunakan + dev/farrel # implementasi ke website (frontend dan backend) + dev/stevan # implementasi ke website (frontend) + ``` + + Jika tidak ditemukan branch yang sesuai, maka Anda bisa membuat branch baru dengan menggunakan perintah berikut: + ```bash + git checkout -b / + ``` + + 3. Buat commit perubahan dengan pesan yang jelas (`git commit -m "menambahkan fitur notifikasi pada pengguna mahasiswa"`). + 4. Buat pull request ke branch utama (`main`). Buat penjelasan singkat mengenai perubahan yang telah dilakukan. + +- Mendapatkan pembaruan terkini dari branch utama + 1. Lakukan upaya pull dengan tetap berada di branch anda. + + > ⚠️ ANDA TIDAK PERLU MENGGANTI BRANCH KE MAIN! GANTI BRANCH MAIN JIKA BENAR-BENAR DIPERLUKAN SAJA! + + Ketikkan perintah berikut di terminal + ```bash + git pull origin main + ``` + Maka akan secara otomatis pembaruan dari branch utama akan masuk ke branch lokal anda + 2. Jika terjadi masalah saat proses penggabungan (merge), pastikan perubahan yang anda lakukan tidak mengganggu perubahan di branch utama. Jika anda bingung, lebih baik hubungi kepada manajer proyek untuk informasi lebih lanjut + +## Panduan kontributor eksternal + +Kontributor eksternal adalah pihak di luar kontributor awal yang menginisasi proyek ini. Berikut adalah beberapa panduan yang perlu dipatuhi oleh para kontributor eksternal: +1. Fork repository ini ke akun Anda. +2. Buat branch baru untuk perubahan Anda (`git checkout -b `). +3. Lakukan perubahan sesuai kebutuhan dan pastikan kode Anda sudah sesuai standar proyek. +4. Commit perubahan Anda dengan pesan yang jelas (`git commit -m "memperbaiki konfigurasi database mysql"`). +5. Buat pull request ke branch utama kami, disertai penjelasan singkat mengenai perubahan yang Anda lakukan. + +Jika perubahan yang anda lakukan berdampak positif terhadap proyek, maka kami akan mempertimbangkan untuk proses *merge* ke branch main. + +--- +--- \ No newline at end of file