Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
66 lines (52 loc) · 3.79 KB

CONTRIBUTING.md

File metadata and controls

66 lines (52 loc) · 3.79 KB

🤝 Panduan Kontribusi untuk Nirkyy Public REST API

Terima kasih banyak atas minat Anda untuk berkontribusi pada proyek REST API Publik Nirkyy! 🎉 Kami sangat senang Anda ingin bergabung dalam perjalanan membangun API publik yang bermanfaat dan mudah diakses.

Proyek ini adalah inisiatif open source publik yang berkembang berkat kolaborasi komunitas. Kontribusi Anda, sekecil apapun, sangat berarti bagi kami.

💖 Filosofi Open Source Kami

Sebagai proyek publik tanpa lisensi formal, kami menganut semangat keterbukaan penuh. Ini berarti:

  • Kebebasan: Anda bebas menggunakan, memodifikasi, dan mendistribusikan kode API ini.
  • Kolaborasi: Kami percaya pada kekuatan kolaborasi. Setiap ide dan perbaikan disambut dengan tangan terbuka.
  • Pembelajaran: Proyek ini juga bisa menjadi sarana belajar bagi para pengembang yang ingin mendalami pengembangan API.

🚀 Bagaimana Cara Berkontribusi?

Berkontribusi pada proyek ini cukup mudah! Ikuti langkah-langkah umum berikut:

1. Fork Repositori

Langkah pertama adalah membuat salinan (fork) dari repositori utama ke akun GitHub Anda. Kunjungi halaman repositori utama dan klik tombol "Fork" di bagian kanan atas.

2. Clone Repositori Fork Anda

Setelah di-fork, clone repositori fork Anda ke mesin lokal Anda menggunakan Git:

git clone https://github.com/Your-Username/NirKyy
cd NirKyy

3. Buat Branch Baru

Sebelum mulai membuat perubahan, buat branch baru. Gunakan nama branch yang deskriptif sesuai dengan tujuan kontribusi Anda (misalnya: feat/tambah-endpoint-cuaca, fix/perbaiki-bug-login, docs/perbarui-readme).

git checkout -b nama-branch-anda

4. Lakukan Perubahan Anda

Sekarang saatnya berkreasi! Lakukan perubahan pada kode atau dokumentasi sesuai dengan kontribusi Anda.

  • Jika Anda menambahkan fitur baru atau memperbaiki bug pada kode, pastikan untuk:
    • Menulis kode yang bersih, mudah dibaca, dan efisien.
    • Menambahkan komentar jika diperlukan untuk menjelaskan logika yang kompleks.
    • Menambahkan atau memperbarui tes (jika ada kerangka kerja tes) untuk mencakup perubahan Anda.
    • Menguji perubahan Anda secara lokal untuk memastikan semuanya berfungsi seperti yang diharapkan.
  • Jika Anda memperbarui dokumentasi, pastikan informasinya akurat dan jelas.

5. Commit Perubahan Anda

Setelah selesai dengan perubahan, commit perubahan tersebut. Kami mendorong penggunaan Conventional Commits untuk pesan commit yang lebih terstruktur (misalnya: feat: tambahkan endpoint cuaca, fix: perbaiki validasi input).

git add .
git commit -m "feat: deskripsi singkat perubahan Anda"

6. Push Branch Anda

Push branch yang baru saja Anda buat beserta commit Anda ke repositori fork Anda di GitHub:

git push origin nama-branch-anda

7. Buat Pull Request (PR)

Buka halaman repositori fork Anda di GitHub. Anda akan melihat notifikasi untuk membuat Pull Request (PR) dari branch Anda ke branch utama (biasanya main atau master) di repositori utama Nirkyy.

  • Klik tombol "Compare & pull request".
  • Berikan judul PR yang jelas dan deskripsi yang menjelaskan perubahan yang Anda buat dan mengapa.
  • Kirim PR Anda. 🧐 Proses Peninjauan Setelah Anda membuat PR, tim atau kontributor lain akan meninjau PR Anda. Mungkin akan ada diskusi, saran perbaikan, atau pertanyaan. Mohon bersabar dan kooperatif selama proses ini. Kami mungkin meminta Anda untuk melakukan perubahan tambahan pada PR Anda. ❓ Pertanyaan atau Bantuan Jika Anda memiliki pertanyaan tentang proses kontribusi, tidak yakin bagaimana memulai, atau memerlukan bantuan dengan PR Anda, silakan buka Issue Baru di repositori utama. Jelaskan pertanyaan atau masalah Anda secara rinci. Terima kasih sekali lagi atas waktu dan usaha Anda untuk berkontribusi pada proyek Nirkyy Public REST API! Kami sangat menantikan kontribusi Anda! ✨