Pythonia

Pythonia

Selamat datang di Pythonia - The Python Functions Collection Repository! Ini adalah repositori publik di mana siapa pun dapat menyumbangkan fungsi ularahan mereka. Baik itu skrip tunggal atau proyek yang lebih kompleks yang dibagi menjadi beberapa file, kontribusi Anda diterima.

Daftar isi

• Tentang
• Bagaimana berkontribusi
• Pedoman
• Struktur folder
• Lisensi
• Menyumbang

Tentang

Repositori ini adalah kumpulan berbagai fungsi dan skrip Python. Tujuannya adalah untuk membuat beragam fungsi berguna yang dapat membantu pengembang dan penggemar lain. Kontribusi dapat berkisar dari fungsi utilitas sederhana hingga proyek yang lebih kompleks.

Bagaimana berkontribusi

Berkontribusi pada repositori ini sederhana. Ikuti langkah -langkah di bawah ini untuk memulai:

1. Fork The Repository : Klik tombol Fork di sudut kanan atas halaman ini.
2. Kloning garpu Anda : Kloning repositori bercabang Anda ke mesin lokal Anda.

   git clone https://github.com/ < your-username > /python-functions-collection.git

3. ** Buat cabang baru: Buat cabang baru untuk kontribusi Anda.

   git checkout -b my-new-function

4. Tambahkan fungsi Anda: Tambahkan fungsi python Anda ke folder yang sesuai atau buat yang baru.
5. Komit perubahan Anda: Komit perubahan Anda dengan pesan komit yang bermakna.

   git add .
   git commit -m " Add new function for XYZ "

6. Dorong ke garpu Anda: Dorong perubahan Anda ke repositori bercabang Anda.

   git push origin my-new-function

7. Buat Permintaan Tarik: Pergi ke repositori asli dan klik tombol New Pull Request .
8. Perbarui file "persyaratan.txt" juga sesuai dengan proyek Anda.

Pedoman

Untuk memastikan repositori tetap terorganisir dan bermanfaat, silakan ikuti panduan ini saat berkontribusi:

• Atur kode dalam folder: Jika kontribusi Anda terdiri dari banyak file atau bagian, letakkan di dalam folder. Beri nama folder secara deskriptif.
• Kontribusi file tunggal: Jika kontribusi Anda adalah file python tunggal, letakkan langsung di bagian yang sesuai.
• Konvensi Penamaan: Gunakan nama deskriptif untuk file dan folder. Hindari nama generik seperti script.py atau function.py.
• Dokumentasi: Sertakan komentar dan dokumen dalam kode Anda untuk menjelaskan fungsinya.
• Pengujian: Jika memungkinkan, sertakan skrip pengujian kecil atau contoh yang menunjukkan cara menggunakan fungsi Anda.
• Informasi Lisensi: Pastikan kontribusi Anda kompatibel dengan lisensi repositori (lihat di bawah).

Struktur folder

Mengatur repositori dengan cara yang bermakna. Inilah contoh struktur:

  Pytonia/
  |
  | -- single_file_functions/
  |   | -- example_function.py
  |
  | -- multi_part_functions/
  |   | -- project_name/
  |       | -- part1.py
  |       | -- part2.py
  |       | -- README.md
  |
  | -- README.md

• single_file_functions: Untuk kontribusi file python tunggal.
• Multi_part_functions: Untuk proyek dengan beberapa bagian/file. Setiap proyek harus memiliki foldernya sendiri.
• README.MD: File ini.

Lisensi

Proyek ini dilisensikan di bawah lisensi MIT. Dengan berkontribusi, Anda setuju bahwa kontribusi Anda akan dilisensikan di bawah lisensi MIT.

Menyumbang

Kami menyambut kontribusi dari semua orang. Begini cara Anda dapat membantu:

• Kirim Laporan Bug dan Permintaan Fitur: Gunakan Pelacak Masalah untuk melaporkan bug atau menyarankan fitur.
• Tinjau Permintaan Tarik: Tinjau permintaan tarik dari kontributor lain.
• Tingkatkan Dokumentasi: Membantu meningkatkan readme ini, menambahkan komentar, dan meningkatkan dokumentasi kode.