Blockly Samples มีเนื้อหาเพิ่มเติมที่เกี่ยวข้องกับ Blockly ที่ไม่ได้เป็นส่วนหนึ่งของที่เก็บหลัก รวมถึงปลั๊กอิน, Codelab และโค้ดตัวอย่าง ดูรายละเอียดเพิ่มเติมของแต่ละฟีเจอร์ได้ในหน้าโครงสร้างของที่เก็บ
จำเป็นต้องทราบ
นี่คือภาพรวมคร่าวๆ ของข้อเท็จจริงเกี่ยวกับตัวอย่างบล็อกที่คุณจำเป็นต้องทราบเพื่อสร้างการประชาสัมพันธ์
- สาขาที่ใช้งานอยู่คือหลัก และ PR ทั้งหมดควรทำเมื่อเทียบกับต้นฉบับ
- เรียกใช้
npm installที่ระดับรากของตัวอย่างบล็อก ไม่ใช่ที่ระดับปลั๊กอินแต่ละรายการ Blockly ตัวอย่างคือเกม Monorepo ซึ่งหมายความว่ามีหลายแพ็กเกจในที่เก็บเดียวกัน และการติดตั้งที่ระดับรากเป็นส่วนหนึ่งของเวิร์กโฟลว์การจัดการ Monorepo ด้วย Lerna - โค้ดต้องเป็นไปตามคู่มือสไตล์ JavaScript หรือคู่มือสไตล์ของ TypeScript ของ Google โดยขึ้นอยู่กับภาษาที่ใช้
- ใช้การคอมมิตแบบทั่วไป ในข้อความคอมมิตและดึงชื่อคำขอ
ไฟล์โค้ดใหม่จะต้องนำหน้าด้วยใบอนุญาต Apache v2.0 ดังต่อไปนี้
/** * @license * Copyright <Current YYYY> Google LLC * SPDX-License-Identifier: Apache-2.0 */
ทำการเปลี่ยนแปลงและยืนยันการเปลี่ยนแปลง
- เรียกใช้
npm installที่ระดับรากของตัวอย่างบล็อกเพื่อติดตั้งทรัพยากร Dependency - เรียกใช้
npm run startในไดเรกทอรีของปลั๊กอินเพื่อสร้างและเริ่มการทำงานของเซิร์ฟเวอร์ที่เรียกใช้หน้าทดสอบของปลั๊กอิน คุณสามารถใช้หน้านี้เพื่อดูลักษณะการทำงานที่มีอยู่ของปลั๊กอิน หรือหากคุณจะเพิ่มปลั๊กอินใหม่ คุณจะต้องทำให้หน้านี้เป็นหน้าทดสอบที่มีประโยชน์เพื่อให้ผู้อื่นเห็นถึงสิ่งที่ปลั๊กอินของคุณทำ ดูหน้า playground สำหรับข้อมูลเพิ่มเติม - ทำการเปลี่ยนแปลงที่จำเป็นกับโค้ดของปลั๊กอิน
- หากคุณปล่อยให้เซิร์ฟเวอร์ทำงานต่อไป ระบบจะโหลดการเปลี่ยนแปลงโดยอัตโนมัติ มิฉะนั้น ให้รีสตาร์ทเซิร์ฟเวอร์และยืนยันว่าปลั๊กอินทำงานตามที่คาดไว้ และไม่มีข้อผิดพลาดหรือคำเตือนในคอนโซล
- เรียกใช้
npm run buildและตรวจสอบว่าไม่มีข้อผิดพลาดของบิลด์ - เขียนการทดสอบมอคค่าอัตโนมัติในไดเรกทอรี
test/ - เรียกใช้
npm run testเพื่อทำการทดสอบอัตโนมัติ - เรียกใช้
npm run lint:fixเพื่อแก้ไขข้อผิดพลาดของ Lint แก้ไขปัญหาคำเตือนหรือข้อผิดพลาด ที่เหลืออยู่ - เรียกใช้
npm run formatเพื่อเรียกใช้ตัวจัดรูปแบบอัตโนมัติ - หากการทดสอบทั้งหมดผ่าน คุณก็พร้อมที่จะเปิด PR เทียบกับโฆษณาหลักด้วยการเปลี่ยนแปลงที่ทำแล้ว