อ่านเพิ่มเติมเกี่ยวกับปลั๊กอิน
กระบวนการ
ปลั๊กอินมี 4 ขั้นตอน ได้แก่ คำแนะนำ การอภิปราย การใช้งาน และ การเผยแพร่
คำแนะนำ
ปลั๊กอินจะเริ่มต้นด้วยคำแนะนำ คุณแนะนำปลั๊กอินได้โดยสร้างปัญหาใหม่ด้วยเทมเพลตคำขอฟีเจอร์
นอกเหนือจากข้อมูลคำขอฟีเจอร์พื้นฐานแล้ว คำแนะนำปลั๊กอินควรมีข้อมูลต่อไปนี้
- API ที่ปลั๊กอินจะแสดง
- API ที่ต้องเพิ่มหรือเปลี่ยนแปลงใน Blockly หลักเพื่อรองรับปลั๊กอิน
- ภาพหน้าจอ, GIF หรือแบบจำลอง ถ้าปลั๊กอินมีคุณลักษณะ UI
- คำอธิบายเหตุผลที่ควรใช้เป็นปลั๊กอินของบุคคลที่หนึ่งแทนที่จะเป็นปลั๊กอินของบุคคลที่สาม
ทีม Blockly จะตรวจสอบคำแนะนำเมื่อได้รับคำแนะนำ และปิดปัญหา หรือเพิ่มป้ายกำกับ status: การสนทนา
พูดคุยกัน
ต่อไป ปลั๊กอินจะเข้าสู่ระยะการอภิปราย ระยะนี้รวมถึง
- การชี้แจงฟังก์ชันการทำงานที่ต้องการ
- การชี้แจง API ของปลั๊กอิน
- การวางแผนสำหรับการนำไปใช้
- การวางแผนสำหรับการทดสอบ
- การสนทนาเรื่องการเปลี่ยนแปลง API หลักใน Blockly
- การแบ่งปลั๊กอินขนาดใหญ่ออกเป็นขั้นตอนการติดตั้งใช้งาน
- การตั้งชื่อปลั๊กอินตามแบบแผนการตั้งชื่อ
- การยืนยันจะตรงตามเกณฑ์ของบุคคลที่หนึ่งทั้งหมด
การสนทนานี้มักเกี่ยวข้องกับปัญหาเกี่ยวกับ GitHub ยิ่งปลั๊กอินมีขอบเขตของปลั๊กอินน้อยเท่าใด การสนทนาก็จะเร็วขึ้นเท่านั้น ปลั๊กอินขนาดใหญ่อาจดึงดูดความสนใจของชุมชน และความคิดเห็นเกี่ยวกับโซลูชันที่เหมาะสม หากสิ่งนี้เกิดขึ้นกับคุณ ก็ขอแสดงความยินดีด้วย! คุณได้พบสิ่งที่ผู้คนสนใจ
เป้าหมายคือในช่วงท้ายของขั้นตอนการสนทนา จะมีการตัดสินใจเรื่องการออกแบบที่สำคัญทั้งหมดและมีรายการขั้นตอนการปรับใช้ที่ชัดเจน คุณควรระบุทั้ง 2 อย่างนี้ไว้ในความคิดเห็นเกี่ยวกับปัญหา
ในระหว่างการสนทนา เราอาจตัดสินใจว่าปลั๊กอินควรเป็นปลั๊กอินของบุคคลที่สาม
และไม่ควรเผยแพร่ภายใต้ขอบเขต @blockly ในกรณีนี้ เราจะอธิบาย
สาเหตุและปิดประเด็นนี้
เมื่อสนทนาเสร็จแล้ว สมาชิกทีม Blockly จะเพิ่มป้ายกำกับ status: การติดตั้งใช้งาน ในปัญหา
การใช้งาน
ขั้นตอนการใช้งานมีดังนี้
- การเรียกใช้
npx @blockly/create-packageเพื่อตั้งค่าปลั๊กอินและไดเรกทอรีจากเทมเพลต ดูข้อมูลเพิ่มเติม... - การนำตรรกะหลักไปใช้กับปลั๊กอิน
- ติดตั้งใช้งาน UI หากจำเป็น
- กำลังทดสอบปลั๊กอินโดยใช้มอคค่า
- จัดทำเอกสารเกี่ยวกับปลั๊กอิน รวมถึง
README
หากปัญหาของปลั๊กอินมีป้ายกำกับ status: Implements แสดงว่าปลั๊กอินพร้อมใช้งานหรือใช้งานอยู่ เพื่อเลี่ยงความพยายามซ้ำซ้อน ทุกคนที่สนใจควรแสดงความคิดเห็นเกี่ยวกับปัญหาและสอบถามว่ายังมีการสนับสนุนอยู่ไหม
สามารถติดตั้งใช้งานโดยผู้ให้ข้อมูลร่วมกันหลายรายได้พร้อมกัน คุณอาจใช้ปลั๊กอินร่วมกันบนส้อมของคุณเอง หรือผ่านพุลคำขอไปยังที่เก็บนี้ หากต้องการทำงานร่วมกันโดยใช้ปลั๊กอินในที่เก็บนี้ โปรดขอให้ทีม Blockly สร้างสาขาฟีเจอร์ให้คุณ
ควรเพิ่มปลั๊กอินลงในไฟล์ gh-pages/index.md ในสาขา master ของตัวอย่างบล็อก ซึ่งจะทำให้ URL ดังกล่าว
ปรากฏบนไซต์ปลั๊กอิน ปลั๊กอินบุคคลที่หนึ่งควรชี้ไปยังหน้าทดสอบ คุณยังสามารถเพิ่มปลั๊กอินของบุคคลที่สามในหน้านี้และชี้ไปที่ลิงก์ตามที่เจ้าของเลือกไว้ เช่น การสาธิตที่โฮสต์ไว้หรือหน้า npm
การเผยแพร่
ขั้นตอนสุดท้ายคือการเผยแพร่ ทีม Blockly ใช้ Lerna เพื่อจัดการการกำหนดเวอร์ชันและการเผยแพร่สำหรับปลั๊กอินทั้งหมด
ทุกวันพฤหัสบดีจะมีการเผยแพร่ปลั๊กอินที่เปลี่ยนแปลงไปตั้งแต่รุ่นสุดท้าย หากต้องการให้เผยแพร่การเปลี่ยนแปลงเร็วยิ่งขึ้น โปรดระบุไว้ในคำขอแบบพุล
เว็บไซต์ปลั๊กอินจะได้รับการอัปเดตด้วยเมื่อมีการเผยแพร่ปลั๊กอิน
ปลั๊กอินที่ไม่พร้อมสำหรับการเผยแพร่ควรมีการทำเครื่องหมาย private ใน package.json กรณีนี้อาจเกิดขึ้นหากปลั๊กอินใช้การเปลี่ยนแปลงที่ยังไม่ได้เผยแพร่ใน core Blockly Core Blockly จะมีการเผยแพร่
ในสัปดาห์สุดท้ายของแต่ละไตรมาส (1 ครั้งทุก 3 เดือน)