pygorithms

Pygorithma

Algoritma ditulis dalam Python. Repositori ini berisi algoritma umum yang dipelajari di kelas CS, dari penyortiran hingga pencarian dan banyak lagi.

Memulai

Karena proyek ini masih cukup kecil, cukup klon repositori dan tulis kode apa pun dalam file Python di direktori root repo. Misalnya, jika Anda ingin menggunakan algoritma Sort Gabungan dari folder penyortiran, Anda dapat membuat file python di direktori root repositori:

merge_sort_example.py

 from sorting.merge_sort import MergeSort

unsorted_list = [5, 3, 4, 1, 2]
sorted_list = MergeSort.sort(unsorted_list)

print("Unsorted: " + str(unsorted_list))
print("Sorted: " + str(sorted_list))

Berkontribusi

Jika Anda ingin berkontribusi, jangan ragu untuk membayar salinan dan memulai. Namun, ada beberapa hal yang harus dilakukan sebelum Anda berkontribusi:

Pytest

Proyek ini menggunakan banyak modul pytest dan kait pra-komit GIT untuk memastikan bug ditangkap sebelum komitmen dilakukan. Anda harus menginstal Pytest di mesin Anda.

Pycodestyle

Proyek ini mengikuti pedoman gaya kode dalam gaya pycodestyle. Anda perlu menginstal pycodestyle di mesin Anda.

mengesahkan

File yang dapat dieksekusi yang disebut Validate datang dalam direktori root repo ini. Untuk memastikan perubahan kode apa pun, lulus Pytest dan Pycodestyle, Anda dapat dengan cukup menjalankan Executable ini untuk memeriksa semua kode untuk Anda.

Mengatur kait git

Seperti yang disebutkan sebelumnya, kait pra-komit digunakan untuk memvalidasi semua kode melewati pytest dan pycodestyle sebelum komitmen diterima. Pada dasarnya, kait ini akan menjalankan validasi yang dapat dieksekusi untuk Anda dan menolak komit jika validasi kembali dengan pesan kesalahan apa pun.

Untuk mengatur kait git ini, cukup jalankan file yang dapat dieksekusi di direktori root repo ini dan akan membuat file untuk secara otomatis memvalidasi kode terhadap pytest dan pycodestyle sebelum komitmen dibuat.