Skip to content

Latest commit

 

History

History
114 lines (84 loc) · 4.97 KB

CONTRIBUTING.md

File metadata and controls

114 lines (84 loc) · 4.97 KB

Panduan Berkontribusi

Kontributor

Kami sangat senang anda telah ikut berkontribusi dalam implementasi algoritma, 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 System.out.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 Java 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 *.java
  • gunakan snake_case atau CamelCase dalam menamakan Variabel p.s : Var. di Java bersifat case sensitive
  • gunakan CamelCase dalam pebuatan package (jangan menggunakan dash "-")

contoh penggunaan variabel yang baik pada java kami menyarankan agar menggunakan struktur kode variable pada java seperti di bawah ini

public class NamaFile {
    public static void main(String[] args) {
        int angka_saya = 12;
        double angka_saya_kedua = 13.2f;
        int angkaSayaKedua = 13;
        double doubleBebasSaya = 19.4f;
    }
}
  • jika menggunakan kelas (class) kami menyarankan untuk kapitalisasi
class NamaMurid {
    // kode disini
}
  • compile file java
javac NamaFile.java
java NamaFile.java

Pull Request (PR)

Pull Request (PR) Yang Baik

  • Lakukan fork pada repository kami
  • Setelah melakukan fork kamu dibebaskan untuk mengubah atau menambah algoritma
  • Untuk Pull Request (PR) merubah diusahakan kamu menerapkan algoritma yang lebih baik dan lebih mudah
  • Setelah merubah, menambah, atau perbaikan dokumentasi, usahakan kamu membuat branch baru sebelum melakukan Pull Request (PR)

tambahan perubahan jika ingin menambahkan algoritma atau script Java, kamu bisa menambahkan perubahan di folder other atau namaPackage di dalam package src\main\java. Jika terdapat beberapa file, sebaiknya file-file tersebut dimasukkan ke dalam satu folder yang sesuai dengan nama script tersebut sebagai contoh :

countBulletSpeed
├── CountBulletSpeed.java
└── FileTambahan.java

git checkout -b <branch_name_buatan_kamu>
git add .
git commit -m "add: menambahkan algoritma baru"
git push origin <branch_name_yang_kamu_buat>
  • Lakukan push ke branch kamu dan kemudian open Pull Request (PR)

Saran Pesan Commit

  • feat: untuk menambah algoritma atau tambahan lainnya
  • fix: untuk mengubah algoritma yang sudah ada atau memperbaiki
  • docs: untuk mengubah atau membuat dokumentasi
  • add: untuk mengubah algoritma atau tambahan lainnya (opsional)

Untuk dokumentasi disarankan untuk tidak menggunakan nama dokumentasi

Pull Request (PR) 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 (PR), kamu bisa laporkan masalah pada issue
  • Jika ada test yang tidak lewat atau gagal, kami akan mengecek kembali perubahan.

Untuk Pull Request (PR) 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 Bellshade Java.