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