Link Search Menu Expand Document

“One of my most productive days was throwing away 1000 lines of code.” - Ken Thompson.

Halaman ini berisi hal-hal yang perlu diketahui dalam berkontribusi dalam Python.


DAFTAR ISI

  1. Standar dan Rekomendasi
    1. Penulisan Kode/Dokumentasi (docstring)
    2. Pengembangan (Developer)
    3. Layanan integrasi
  2. Struktur hidrokit

Standar dan Rekomendasi

Penulisan Kode/Dokumentasi (docstring)

  • Usahakan menulis se-Python mungkin (pythonic way).
  • Untuk penulisan docstring, proyek ini menggunakan format numpydoc. Baca panduan penulisannya.
  • Jika anda menggunakan Visual Studio Code, gunakan extension AutoDocstring dengan pengaturan untuk numpydoc.
  • Menggunakan standar gaya tulis (style) PEP 8.

Pengembangan (Developer)

  • Disarankan menggunakan conda sebagai virtual environment. Anda bisa menggunakan instalasi menggunakan environment.yml di dalam direktori proyek ini.
  • Testing menggunakan pytest.

Layanan integrasi

  • Github Actions Pytest. Digunakan untuk testing berdasarkan pytest. Pytest mengabaikan subpaket .contrib.
  • Untuk proses pull request berhasil, hasil dari pytest harus berhasil.

Struktur hidrokit

Sejak versi 0.3.x, pengembangan sementara fokus pada subpaket .contrib.

hidrokit@master/hidrokit        # version=0.4.0
|   __init__.py
|   __version__.py
|
+---analysis                    # direktori khusus kumpulan modul analisis data
|       __init__.py
|
+---contrib                     # direktori khusus untuk kontributor
|   |   __init__.py             # pengembangan fokus di .contrib sejak 0.3.x
|   |
|   \---taruma
|           anfrek.py
|           hk102.py
|           hk106.py
|           hk124.py
|           hk126.py
|           hk127.py
|           hk140.py
|           hk141.py
|           hk151.py
|           hk158.py
|           hk172.py
|           hk43.py
|           hk53.py
|           hk73.py
|           hk79.py
|           hk84.py
|           hk87.py
|           hk88.py
|           hk89.py
|           hk90.py
|           hk96.py
|           hk98.py
|           hk99.py
|           ujidist.py
|           __init__.py
|
+---prep                        # direktori khusus kumpulan modul persiapan data
|       excel.py
|       read.py
|       timeseries.py
|       __init__.py
|
\---viz                         # direktori khusus kumpulan modul visualisasi data
        graph.py
        table.py
        __init__.py

Perubahan pada direktori dimungkinkan jika diperlukan.


Masih mau baca tentang cara berkontribusi?

Dokumentasi Situs Hidrologi