Berkontribusi

Semua kontribusi untuk Ormar dipersilakan!

pertanyaan

Untuk membuatnya semudah mungkin bagi kami untuk membantu Anda, harap sertakan yang berikut ini:

Sistem Operasi
Versi ular piton
Versi ormar
Database backend (MySQL, SQLite, atau PostgreSQL)

Harap coba untuk selalu menyertakan hal-hal di atas, kecuali jika Anda tidak dapat menginstal Ormar atau mengetahui bahwa itu tidak relevan dengan masalah atau permintaan fitur Anda.

permintaan permintaan

Memulai dan membuat permintaan tarik harus sangat sederhana.

!!!Hati-hati, kecuali perubahan Anda kecil (salah ejaan, penyesuaian dokumen, dll.), buat pertanyaan untuk mendiskusikan perubahan sebelum membuat permintaan tarik.

Untuk membuat kontribusi sesederhana dan secepat mungkin, Anda perlu menjalankan tes dan menghubungkan secara lokal.

Anda perlu menginstal Python 3.6.2, 3.7 atau 3.8, puisi dan git.

# 1. kloning garpu dan cd Anda ke dalam direktori repo
Klon Git git@github.com:<your username>/ ormar.git
CD ormar

# 2. Pasang ormar, dependensi, dan uji ketergantungan
Pembuatan puisi -E dev

# 3. Periksa cabang baru dan buat perubahan Anda
Git checkout -b my-new-feature-branch
# buat perubahanmu...

# 4. Pemformatan dan linting
# ormar menggunakan hitam untuk memformat, serpi8 untuk menghubungkan dan mypy untuk memeriksa petunjuk tipe
# jalankan semua berikut karena semua panggilan itu akan di jalankan dalam perjalanan setelah setiap dorongan
Tes badai hitam
Flake8 ormar
Tes ormar tiruan

#5.Run tes
# pada localhost semua tes di jalankan terhadap sglite backend
# Sisa backends akan diperiksa setelah didorong
Pytest -svv --cov = ormar --cov = tes --cov-fail-under=100 --cov-report=term-missing

#6.Build dokumentasi
Gedung MKDOCS
# jika Anda telah mengubah dokumentasi pastikan itu berhasil dibangun
# Anda juga dapat menggunakan `mkdocs serve` untuk melayani dokumentasi di localhost:8000

#... berkomitmen, dorong, dan buat permintaan tarikan Anda

!!!Tip Untuk informasi lebih lanjut tentang cara dan mengapa ormar bekerja seperti itu, lihat dokumentasi API