เอกสารนักพัฒนาได้ย้ายแล้ว! ดู https://www.popclip.app/dev/ สำหรับเอกสารล่าสุด
ส่วนขยาย popclip
ที่เก็บนี้มีไฟล์ต้นฉบับสำหรับส่วนขยายจำนวนมากที่เผยแพร่ในไดเรกทอรีส่วนขยาย Popclip อย่างเป็นทางการ
เค้าโครงที่เก็บ
โฟลเดอร์หลัก:
-
source - แหล่งที่มาสำหรับส่วนขยายที่เผยแพร่ (ดูแลและสนับสนุนโดยฉัน) -
contrib - โฟลเดอร์สำหรับส่วนขยายที่ไม่ได้เผยแพร่ / ผู้ใช้ / การทดลอง / การทดลอง / ซอก / เก็บถาวร (ไม่ได้รับการดูแลหรือสนับสนุน)
การบริจาค
การแก้ไขและการปรับปรุงส่วนขยายที่มีอยู่ยินดีต้อนรับผ่านคำขอดึง
เพื่อสนับสนุนส่วนขยายใหม่ไปยังไดเรกทอรีวิธีที่ต้องการคือให้คุณส่งโดยตรงไปยังเซิร์ฟเวอร์ไดเรกทอรีจาก repo ของคุณเอง หน้าไดเรกทอรีส่วนขยายจะเชื่อมโยงกับ repo ของคุณและคุณจะรักษาและอัปเดตส่วนขยายด้วยตัวเอง ติดต่อฉันที่ Mailto: [email protected] สำหรับคำแนะนำในการส่ง
อีกทางเลือกหนึ่งอาจส่งส่วนขยายใหม่โดยคำขอดึง ในโฟลเดอร์ contrib ของ repo นี้ (ถ้าฉันเผยแพร่ฉันจะย้ายไปยังโฟลเดอร์ source ด้วยตัวเอง)
แนวทางคุณภาพ
โปรดทราบว่าฉันจะไม่เผยแพร่ผลงานทั้งหมด ส่วนขยายที่จะเผยแพร่จะต้องมีคุณภาพสูงและเป็นไปตามเกณฑ์ดังต่อไปนี้:
- ส่วนขยายมีจุดประสงค์เดียวที่ชัดเจนและเป็นประโยชน์ต่อผู้ชมทั่วไป
- ส่วนขยาย "Just Works" โดยมีเพียงการกำหนดค่าขั้นต่ำโดยผู้ใช้
- ชื่อที่ได้รับการคัดเลือกมาอย่างดีเพื่อให้สอดคล้องกับรูปแบบการตั้งชื่อของส่วนขยายอื่น ๆ ชื่อมักจะเป็นหนึ่งหรือสองคำ ตัวอย่างเช่น✅ "Instapaper" ไม่ใช่ "ส่งไปยัง Instapaper"; ✅ "uppercase" ไม่ใช่ "แปลงเป็นตัวพิมพ์ใหญ่"
- ไอคอนที่ดีแสดงถึงการกระทำที่ชัดเจน (ใช้สัญลักษณ์ไอคอนหรือ SF หากคุณไม่ใช่นักออกแบบ)
- ในการกำหนด
description ที่ชัดเจนรัดกุมหนึ่งประโยคเกี่ยวกับสิ่งที่ส่วนขยายทำ นี่คือสิ่งที่ปรากฏบนเว็บไซต์ถัดจากชื่อส่วนขยาย - นอกเหนือจากส่วนขยายที่ง่ายที่สุดรวมถึงไฟล์
readme.md ที่อธิบายสั้น ๆ เกี่ยวกับวิธีการใช้ส่วนขยายโดยเฉพาะอย่างยิ่งการกล่าวถึงคุณสมบัติพิเศษและตัวเลือกการกำหนดค่า เพิ่มการเปลี่ยนแปลงที่ด้านล่างของ readme - ในกรณีที่จำเป็นต้องมีคีย์ API ควรบันทึกไว้อย่างชัดเจนใน readMe พร้อมคำแนะนำและลิงก์เพื่อรับคีย์
- ไม่มีสคริปต์ที่ไม่มีจุดหมาย ตัวอย่างเช่นอย่าใช้สคริปต์ทุบตีเพื่อเปิด URL เมื่อคุณสามารถใช้การกระทำ
url - สนับสนุนการกระทำของ JavaScript ผ่านการกระทำของเชลล์สคริปต์หรือแอปเปิ้ลสคริปต์เว้นแต่การกระทำเฉพาะจะต้องเป็นเชลล์สคริปต์หรือแอปเปิ้ลสคริปต์
- ส่วนขยายของเชลล์สคริปต์จะต้องทำงานนอกกรอบในการติดตั้ง MacOS ล่าสุด ฉันจะไม่เผยแพร่ส่วนขยายที่ต้องการให้ผู้ใช้ติดตั้งภาษาสคริปต์เพิ่มเติมหรือไลบรารี
- ใช้ readMe เพื่อให้เครดิตกับตัวเองในฐานะผู้เขียนและรับทราบผู้มีส่วนร่วมอื่น ๆ ห้องสมุดโอเพนซอร์สหรือผู้สร้างไอคอน
- ไม่มีไบนารีที่รวบรวม การส่งทั้งหมดจะต้องเป็นซอร์สโค้ดเท่านั้น
- ส่วนขยายที่โต้ตอบกับเว็บไซต์หรือแอพควรมีพจนานุกรม
app ในการกำหนดค่ากำหนด name และฟิลด์ link ชื่อจะเชื่อมโยงโดยอัตโนมัติในคำอธิบายส่วนขยาย - สำหรับส่วนขยายที่ทำงานกับแอพ MacOS ของบุคคลที่สามคีย์
bundleIdentifiers พร้อมตัวเลือก checkInstalled: true ก็ควรใช้เช่นกัน - ไม่มีส่วนขยายที่มุ่งไปที่การหลีกเลี่ยงลิขสิทธิ์การเอาชนะ paywall ฯลฯ
- ไม่มีลิงก์ไปยังไซต์ Torrent / Filesharing ที่ดัชนีส่วนใหญ่มีการจัดทำดัชนีเนื้อหาที่มีลิขสิทธิ์
- ไม่มีอะไรที่ "โทรศัพท์บ้าน" รวบรวมข้อมูลผู้ใช้หรือปรับเปลี่ยนระบบของผู้ใช้ในทางใดทางหนึ่ง
- ไม่มีอะไรผิดกฎหมายหรือเป็นอันตรายหรือว่าคุณจะไม่แสดงต่อยายของคุณ
- รายการข้างต้นไม่ครบถ้วนสมบูรณ์และขอสงวนสิทธิ์ในการปฏิเสธการส่งด้วยเหตุผลอื่นใด
จากทั้งหมดที่กล่าวมา ... โปรดส่งส่วนขยายของคุณ! ฉันรอคอยที่จะได้เห็นสิ่งที่คุณเกิดขึ้น
การให้เครดิต
เครดิตจะรวมอยู่ในไฟล์ readme ส่วนขยายส่วนบุคคล
ใบอนุญาต
ซอร์สโค้ดทั้งหมดถูกเผยแพร่ภายใต้ใบอนุญาต MIT (license.txt) เว้นแต่จะระบุไว้เป็นอย่างอื่นในไฟล์ ReadMe ส่วนขยาย
การเปลี่ยนแปลง
การเปลี่ยนแปลงส่วนบุคคลรวมอยู่ในไฟล์ Readme ส่วนขยาย