Skip to content

Latest commit

 

History

History
104 lines (76 loc) · 4.28 KB

CONTRIBUTING.md

File metadata and controls

104 lines (76 loc) · 4.28 KB
Raw

Panduan Berkontribusi

Kontributor

Kami sangat senang anda telah ikut berkontribusi dalam implementasi algortima, struktur data atau memperbaiki error. Semua boleh ikut berkontribusi walaupun hal kecil dengan pengecualian sebagai berikut:

  • Hasil pekerjaan kamu adalah buatan kamu sendiri dan tidak ada hak cipta dari orang lain.
  • Jika kami menemukan kesamaan maka kami tidak merged.
  • Hasil kerja kamu akan berlisensi MIT ketika permintaan pull kamu sudah di merged.
  • Hasil kerja kamu wajib mengikuti standar dan style koding dari kami.
  • Menggunakan output println().
  • Menghindari penggunaan library pada koding (jika dibutuhkan silahkan diskusi di issue).

Apa Itu Algoritma?

Algoritma adalah langkah-langkah untuk menyelesaikan suatu pekerjaan dimana terdiri dari 3 bagian utama, yaitu:

  • Input/masukan, sebelum menjalankan sebuah algoritma maka hal yang pertama harus dilakukan adalah menerima masukan, input dapat berasal dari pengguna ataupun dari langkah sebelumnya.
  • Proses, bagian utama dari algoritma yang melakukan pengolahan input yang akan menghasilkan output.
  • Output/keluaran, output adalah hasil dari bagian proses, output ini juga bisa digunakan untuk langkah selanjutnya (jika masih ada).

Algoritma harus dikemas sedemikian rupa sehingga memudahkan pembaca untuk memasukkannya ke dalam program yang lebih besar.

Algoritma harus memiliki:

  • Memiliki nama kelas dan fungsi intuitif yang memperjelas tujuannya bagi pembaca
  • Menggunakan konvensi penamaan Kotlin dan nama variabel intuitif untuk memudahkan pemahaman
  • Fleksibel untuk mengambil nilai input yang berbeda
  • Memiliki docstrings dengan penjelasan yang jelas dan/atau URL ke materi sumber
  • Berisi doctests yang menguji nilai input yang valid dan salah
  • Kembalikan semua hasil perhitungan alih-alih mencetak atau memplotnya

Informasi Perubahan dan Penambahan

Persyaratan perubahan atau penambahan kode

  • pastikan file ekstensi berupa *.kt
  • gunakan CamelCase dalam menamakan Variabel, Function, ataupun Class

Contoh penggunaan variabel yang baik pada kotlin kami menyarankan agar menggunakan struktur kode Variabel, Function, ataupun Class pada kotlin seperti dibawah ini

class NamaFile{
  fun main(){
    var angkaSaya = 12;
    val angkaSayaKedua = 13.2f;
  }

  fun contohFunction(){
    // kode disini
  }
}
  • compile file kotlin
kotlinc NamaFile.kt -include-runtime -d NamaOutputFile.jar

java -jar NamaOutputFile.jar

Pull Request

Pull Request Yang Baik

  • Lakukan fork pada repository kami
  • Setelah melakukan fork kamu dibebaskan untuk mengubah atau menambah algoritma
  • Untuk pull request merubah diusahakan kamu menerapkan algoritma yang lebih baik dan lebih mudah
  • Setelah merubah, menambah, atau perbaikan dokumentasi, usahakan kamu membuat branch baru

Tambahan perubahan jika ingin menambahkan algoritma atau script kotlin,kamu bisa menambahkan perubahan di folder other. jika terdapat beberapa file, sebaiknya file-file tersebut dimasukkan ka dalam satu folder yang sesuai dengan nama script tersebut sebagai contoh

count_bullet_speed
├── CountBulledSpeed.kt
└── FileTambahan.kt

git checkout -b <branch_name>
git add .
git commit -m "add: menambahkan algoritma baru"
  • Lakukan push ke branch kamu dan kemudian open pull request

Saran Pesan Commit

  • add untuk menambah algoritma atau tambahan lainnya
  • fix untuk mengubah algoritma yang sudah ada atau memperbaiki
  • docs untuk mengubah atau membuat dokumentasi
  • style untuk mengubah atau memperbaiki style kode untuk contohnya bisa dilihat pada commit yang diatas

Pull request merged jika:

  • Mengikuti standar dan arahan dari CONTRIBUTING.md
  • Lulus test dan cek dari beberapa test yang sudah kami siapkan

Tambahan

  • Jika ada kendala atau masalah dalam pull request, kamu bisa laporkan masalah pada issue
  • Jika ada test yang tidak lewat atau gagal, kami akan mengecek kembali perubahan.

Untuk pull request kami sarankan untuk menjelaskan secara detail yang kamu ubah atau tambahkan, dan bersikap sopan, serta selalu berterima kasih, itu salah satu bentuk tata krama yang baik terhadap sesama contributor dan programmer lainnya. Terima kasih sudah berkontribusi di Kotlin.