Pythonia
ยินดีต้อนรับสู่ Pythonia - ที่เก็บคอลเลกชันฟังก์ชั่น Python! ที่นี่เป็นที่เก็บสาธารณะที่ทุกคนสามารถมีส่วนร่วมในฟังก์ชั่น Python ของพวกเขา ไม่ว่าจะเป็นสคริปต์เดียวหรือโครงการที่ซับซ้อนมากขึ้นแบ่งออกเป็นหลายไฟล์ยินดีต้อนรับการมีส่วนร่วมของคุณ
สารบัญ
- เกี่ยวกับ
- วิธีการมีส่วนร่วม
- แนวทางปฏิบัติ
- โครงสร้างโฟลเดอร์
- ใบอนุญาต
- มีส่วนช่วย
เกี่ยวกับ
ที่เก็บนี้เป็นคอลเลกชันของฟังก์ชั่นและสคริปต์ Python ต่างๆ เป้าหมายคือการสร้างฟังก์ชั่นที่มีประโยชน์ที่หลากหลายซึ่งสามารถช่วยนักพัฒนาและผู้ที่ชื่นชอบคนอื่น ๆ การมีส่วนร่วมอาจมีตั้งแต่ฟังก์ชั่นยูทิลิตี้อย่างง่ายไปจนถึงโครงการที่ซับซ้อนมากขึ้น
วิธีการมีส่วนร่วม
การมีส่วนร่วมในที่เก็บนี้เป็นเรื่องง่าย ทำตามขั้นตอนด้านล่างเพื่อเริ่มต้น:
- ส้อมที่เก็บ : คลิกที่ปุ่ม
Fork ที่มุมบนขวาของหน้านี้ - โคลนส้อมของคุณ : โคลนที่เก็บข้อมูลของคุณไปยังเครื่องในพื้นที่ของคุณ
git clone https://github.com/ < your-username > /python-functions-collection.git
- ** สร้างสาขาใหม่: สร้างสาขาใหม่สำหรับการมีส่วนร่วมของคุณ
git checkout -b my-new-function
- เพิ่มฟังก์ชั่นของคุณ: เพิ่มฟังก์ชั่น Python ของคุณลงในโฟลเดอร์ที่เหมาะสมหรือสร้างฟังก์ชันใหม่
- กระทำการเปลี่ยนแปลงของคุณ: กระทำการเปลี่ยนแปลงของคุณด้วยข้อความการกระทำที่มีความหมาย
git add .
git commit -m " Add new function for XYZ "
- กดไปที่ส้อมของคุณ: ผลักดันการเปลี่ยนแปลงของคุณไปยังที่เก็บข้อมูลของคุณ
git push origin my-new-function
- สร้างคำขอดึง: ไปที่ที่เก็บต้นฉบับและคลิกที่ปุ่ม
New Pull Request - อัปเดตไฟล์ "txt.txt" ตามโครงการของคุณด้วย
แนวทางปฏิบัติ
เพื่อให้แน่ใจว่าพื้นที่เก็บข้อมูลยังคงมีการจัดระเบียบและมีประโยชน์โปรดปฏิบัติตามแนวทางเหล่านี้เมื่อมีส่วนร่วม:
- จัดระเบียบรหัสในโฟลเดอร์: หากการสนับสนุนของคุณประกอบด้วยหลายไฟล์หรือชิ้นส่วนให้วางไว้ในโฟลเดอร์ ตั้งชื่อโฟลเดอร์เชิงพรรณนา
- การมีส่วนร่วมไฟล์เดียว: หากการสนับสนุนของคุณเป็นไฟล์ Python เดียวให้วางไว้ในส่วนที่เหมาะสมโดยตรง
- การตั้งชื่อการประชุม: ใช้ชื่อเชิงพรรณนาสำหรับไฟล์และโฟลเดอร์ หลีกเลี่ยงชื่อทั่วไปเช่น script.py หรือ function.py
- เอกสาร: รวมความคิดเห็นและเอกสารในรหัสของคุณเพื่ออธิบายการทำงานของมัน
- การทดสอบ: ถ้าเป็นไปได้ให้รวมสคริปต์ทดสอบขนาดเล็กหรือตัวอย่างที่แสดงวิธีใช้ฟังก์ชั่นของคุณ
- ข้อมูลใบอนุญาต: ตรวจสอบให้แน่ใจว่าการมีส่วนร่วมของคุณเข้ากันได้กับใบอนุญาตของที่เก็บ (ดูด้านล่าง)
โครงสร้างโฟลเดอร์
จัดระเบียบที่เก็บด้วยวิธีที่มีความหมาย นี่คือโครงสร้างตัวอย่าง:
Pytonia/
|
| -- single_file_functions/
| | -- example_function.py
|
| -- multi_part_functions/
| | -- project_name/
| | -- part1.py
| | -- part2.py
| | -- README.md
|
| -- README.md
- single_file_functions: สำหรับการมีส่วนร่วมไฟล์ Python เดียว
- multi_part_functions: สำหรับโครงการที่มีหลายส่วน/ไฟล์ แต่ละโครงการควรมีโฟลเดอร์ของตัวเอง
- readme.md: ไฟล์นี้
ใบอนุญาต
โครงการนี้ได้รับใบอนุญาตภายใต้ใบอนุญาต MIT โดยการบริจาคคุณยอมรับว่าการบริจาคของคุณจะได้รับใบอนุญาตภายใต้ใบอนุญาต MIT
มีส่วนช่วย
เรายินดีต้อนรับการมีส่วนร่วมจากทุกคน นี่คือวิธีที่คุณสามารถช่วยได้:
- ส่งรายงานข้อผิดพลาดและคำขอคุณสมบัติ: ใช้ตัวติดตามปัญหาเพื่อรายงานข้อบกพร่องหรือคุณสมบัติแนะนำ
- ตรวจสอบคำขอดึง: ตรวจสอบคำขอดึงจากผู้มีส่วนร่วมอื่น ๆ
- ปรับปรุงเอกสาร: ช่วยปรับปรุง readme นี้เพิ่มความคิดเห็นและปรับปรุงเอกสารรหัส