From 9af63e0d5d101c553ee9f4ae9eb96ab30af5dfcc Mon Sep 17 00:00:00 2001 From: Bagus Aditama Date: Sat, 11 Sep 2021 17:48:02 +0700 Subject: [PATCH] =?UTF-8?q?docs=20|=20=E2=9E=95=20menambah=20dan=20menguba?= =?UTF-8?q?h=20docs=20contrib=20&=20readme?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .gitignore | 1 + CONTRIBUTING.md | 87 +++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 14 +++++++- 3 files changed, 101 insertions(+), 1 deletion(-) create mode 100644 CONTRIBUTING.md diff --git a/.gitignore b/.gitignore index dbef116..d9069bb 100644 --- a/.gitignore +++ b/.gitignore @@ -19,3 +19,4 @@ doc/api/ *.js_ *.js.deps *.js.map +*.code-workspace \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..ad83562 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,87 @@ +# Contributing + +**Contributor** + +Kami sangat senang anda telah ikut berkontribusi dalam implementasi algoritma, struktur data atau memperbaiki error serta merilis implementasi materi basic learning Dart. + +Semua orang boleh ikut berkontribusi walaupun hal kecil, dengan ketentuan sebagai berikut: + +- Hasil pekerjaan anda adalah buatan anda sendiri dan tidak ada hak cipta dari orang lain, jika kami menemukan kesamaan maka kami tidak `merged`. +- Hasil kerja anda akan berlisensi [MIT](LICENSE) ketika permintaan pull anda sudah di merged +- Hasil kerja anda wajib mengikuti standar dan style koding dari kami (lihat bagian [Standar penulisan](#standar-penulisan)) +- Untuk Flutter, hanya gunakan package dari [pub.dev](https://pub.dev) jika memang membutuhkan. Sebelumnya silahkan diskusi di [issue](https://github.com/bellshade/Dart/issues) +- Untuk Dartlang, hindari penggunaan library/package pada koding (jika dibutuhkan, silahkan diskusi di [issue](https://github.com/bellshade/JavascriptAlgorithm/issues)) + +## Kategori yang ada + +**1. Basic Learning** + +Basic learning adalah kumpulan implementasi kode materi mendasar dan fundamental untuk pemrograman Dart. Dikemas dengan keterangan kode yang mudah di mengerti sehingga bisa dijadikan referensi untuk kalian yang belajar pemrograman Dart. +> Semua implementasi kode untuk Basic Learning bisa ditemukan di **`/dartlang/basics`** + +**2. 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 _class_ dan fungsi intuitif yang memperjelas tujuannya bagi pembaca +- fleksibel untuk mengambil nilai input yang berbeda +- memiliki dokumentasi penjelasan yang jelas dan/atau URL ke materi sumber +- gunakan hasil kembalian / _return_ daripada langsung mencetak ke layar + +> Semua implementasi kode untuk Algorithm bisa ditemukan di **`/dartlang/algorithms`** + +## Standar Penulisan + +Gunakan standar penulisan yang sudah ditentukan oleh Dart, dan direkomendasikan menggunakan fitur code formatter dari Flutter. + +Untuk dokumentasi mengenai standar penulisan bisa dilihat di link berikut : +[1. Overview Bahasa Dart](https://dart.dev/guides/language/effective-dart) +[2. Gaya Penulisan Dart](https://dart.dev/guides/language/effective-dart/style) +[3. Pembuatan Dokumentasi Kode Dart](https://dart.dev/guides/language/effective-dart/documentation) +[4. Penggunaan Bahasa Dart](https://dart.dev/guides/language/effective-dart/usage) +[5. Penulisan Konsisten Pada Bahasa Dart](https://dart.dev/guides/language/effective-dart/design) + + +## Berkontribusi + +**Pull request yang baik** + +- lakukan fork pada repository ini +- setelah melakukan fork anda dibebaskan untuk mengubah atau menambah algoritma + - untuk pull request "mengubah" diusahakan anda menerapkan algoritma yang lebih baik dan lebih mudah +- setelah mengubah, menambah, atau perbaikan dokumentasi, usahakan anda membuat branch baru + +```bash +git checkout -b +git add . +git commit -m "add: menambahkan algoritma baru" +``` + +- lakukan push ke branch anda 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, anda bisa laporkan masalah pada [issue](https://github.com/bellshade/Dart/issues) +- jika ada test yang tidak lewat atau gagal, kami akan mengecek kembali perubahan. + +untuk pull request kami sarankan untuk menjelaskan secara detail yang anda 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/Dart** \ No newline at end of file diff --git a/README.md b/README.md index 5705ad1..3cb5b60 100644 --- a/README.md +++ b/README.md @@ -1 +1,13 @@ -# Dart \ No newline at end of file +# Dart + +![license](https://img.shields.io/github/license/bellshade/Dart?style=for-the-badge) + +Repositori ini berisi kumpulan dari berbagai macam contoh struktur data, algoritma dan komputasi matematika yang diimplementasikan dengan menggunakan bahasa pemrograman Dart. + +## Peraturan dan Pedoman Kontribusi +Dipersilahkan bila ingin melakukan open pull requets atau kontribusi pada repositori **Dart**. Sebelum itu, bacalah terlebih dahulu [peraturan dan pedomannya](CONTRIBUTING.md) yang dapat ditemukan pada ``CONTRIBUTING.md``. + +## Quick Access +Semua *script* yang ada pada repositori ini, dapat diakses dengan cepat lewat link berikut: + +- \ No newline at end of file