β€œDiscussion is welcome. Judgement is not”


πŸ‘‹ Terima kasih sebelumnya dalam mempertimbangkan untuk berkontribusi di proyek hidrokit. hidrokit memerlukan bantuan dari Anda. Anda dapat berkontribusi dalam berbagai bentuk berupa ide, keahlian teknis, koreksi, diskusi, dan apapun yang menurut Anda bisa memajukan dan mengembangkan proyek ini.

Sebelumnya, kami harap setiap individu dalam komunitas ini mengikuti kode etik yang berlaku. Mari buat lingkungan yang nyaman, bersahabat, dan kondusif dalam pengembangan proyek ini. Mari belajar bersama dari satu sama lain dalam membangun proyek ini.

Daftar isi

  1. Siapapun bisa berkontribusi
  2. Roadmap
  3. Kategori Kontribusi
  4. Issue dan Pull request
  5. Aturan
  6. Yang perlu Anda ketahui
    1. Git
    2. Github
    3. Lisensi

Siapapun bisa berkontribusi

Kontribusi di hidrokit tidak selalu berbentuk implementasi kode. Kontribusi dapat berupa menulis panduan (dokumentasi), mengajukan ide, ikut berdiskusi, mengusulkan fitur baru, memperbaiki tata cara penulisan, memperbaiki kode yang sudah ada, dll. Sehingga proyek ini terbuka untuk siapapun dengan latar belakang apapun.

Halaman How to Contribute to Open Source menjelaskan secara umum dan detail apa saja yang bisa kamu kontribusikan dalam proyek open-source dan manfaatnya bagi Anda.

Anda juga bisa menganggap proyek ini sebagai latihan Anda atau langkah awal dalam memulai kontribusi di proyek open source demi membangun kepercayaan diri, mengasah berkomunikasi dan keahlian Anda, dan berbagi hasil karya Anda.

Roadmap

Untuk memantau status pengembangan hidrokit, Anda bisa melihatnya pada halaman isu di github atau halaman project github.

Kategori Kontribusi

Kami membagi kontribusi menjadi empat kategori utama yaitu:

  1. Dokumentasi: koreksi dokumentasi, penerjemahan, penulisan/pengejaan, komunikasi, dan kerapihan, dll. Bertujuan untuk memudahkan pengguna dalam menggunakan produk.
  2. Situs: pengembangan situs, koreksi penulisan/pengejaan, penambahan konten, memperbagus situs, dll. Bertujuan memudahkan pengguna mencari informasi melalui situs.
  3. Hidrologi: mengusulkan ide pemodelan/metode, mengoreksi/memperjelas teori, dll. Bertujuan membahas aspek hidrologi/keairan/sumberdaya air dalam proyek.
  4. Python: testing, koreksi implementasi kode, dll. Bertujuan membahas aspek implementasi kode/pemrograman dalam proyek.

Untuk panduan berkontribusi yang lebih detail bisa mengunjungi halamannya masing-masing.

Issue dan Pull request

Ada dua istilah yang akan sering digunakan dalam proyek ini yaitu isu (issue) dan pull request (PR) saat berbicara berkontribusi. Isu bisa dibilang seperti tiket, yang dibuat untuk membahas suatu ide/masalah. Ketika isu dibuat, orang lain bisa melihat isu Anda. Jika ada kontributor yang tertarik mengatasi isu Anda, kontributor akan forking repo utama dan mulai mengubah kode/data untuk menyelesaikan isu Anda. Setelah kontributor selesai dengan perubahannya, kontributor akan meminta pull request atau PR untuk menggabungkan hasil kerjaan kontributor ke repo utama. Ilustrasi proses ini bisa dilihat di video berikut:


Langsung ada ide? πŸ™€ Buruan buat isu / pull request sebelum idenya terbang. πŸ’ΈπŸ’Έ ️

Buat Isu Buat Pull Request


Aturan

Segala bentuk komunikasi harus mengikuti kode etik yang berlaku.

Kami menyarankan mengikuti beberapa saran berikut ini saat berkomunikasi di Github dan/atau di dalam komunitas hidrokit:

  • Menggunakan bahasa Indonesia atau bahasa Inggris (utamakan bahasa yang Anda kuasai). Penggunaan bahasa Indonesia sangat dianjurkan.
  • Hindari menggunakan bahasa daerah, bahasa gaul, atau menyingkat kata/kalimat yang tidak umum.
  • Menggunakan panggilan netral dan inklusif. Hindari menggunakan panggilan seperti pak/bu/kak/mas/bos. (Dinyatakan pada kode etik paragraf pertama bagian janji kami)

Yang perlu Anda ketahui

Berikut daftar yang sebaiknya Anda ketahui saat berkontribusi. Git dan Github memiliki tahapan awal learning curve yang lumayan (belum lagi python πŸ˜…), sehingga sangat diwajari jika suatu waktu Anda mentok/buntu. Diharapkan hal tersebut tidak membuat Anda mundur untuk memulai/melanjutkan berkontribusi. Jangan ragu untuk menanyakan atau menceritakan pengalaman Anda di komunitas hidrokit.

β€œIf everyone waited to become an expert before starting, no one would become an expert. To become an EXPERT, you must have EXPERIENCE. To get EXPERIENCE, you must EXPERIMENT! Stop waiting. Start stuff.” - Richie Norton

Git

Karena proyek ini menggunakan Git sebagai version control yang ditampung di GitHub, kontributor diharapkan memahami cara kerja berkontribusi menggunakan Git/Github. Jika ini pertama kalinya Anda menggunakan Git/Github, Anda bisa mengikuti kursus/latihan yang disediakan oleh Github di Github Lab Training. Anda juga bisa mengunjungi masing-masing halaman kategori kontribusi untuk memperoleh panduan lebih detail.

Bacaan lebih lanjut:

Jangan ragu untuk bertanya dan mendiskusikan jika mengalami kesulitan (baik pertanyaan terkait proyek, atau cara berkontribusi).

Github

Proyek ini akan menggunakan wadah Github sebagai alat komunikasi utama, sehingga diharapkan untuk membiasakan dan menyesuaikan bentuk komunikasi. Github menggunakan sintaks penulisan Markdown. Oh πŸ’‘, penggunaan emoji πŸ™Œ sangat dianjurkan. πŸŽ‰

Baca lebih lanjut:

Lisensi

Dalam berkontribusi harap mengingat dan mematuhi lisensi yang berlaku pada sebuah produk yang dimasuk. Jika Anda menyertakan potongan kode, harap menyertakan lisensinya dan menyertakan pemiliknya. Lisensi proyek hidrokit sendiri mengikuti lisensi MIT. Untuk sumber yang digunakan dalam proyek ini bisa dilihat di halaman Sumber.


Tunggu apa lagi? πŸ€” Ayo langsung buat issue atau pull request! πŸƒβ€β™‚οΈ

Buat Isu Buat Pull Request


Mau baca lagi? 😲 Saya kasih yang lebih detail! πŸ˜‰

Dokumentasi Situs Hidrologi Python