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