คู่มือข้อความคอมมิต

ข้อความคอมมิต

ข้อความคอมมิตที่ชัดเจนช่วยให้ตรวจสอบคำขอพุลได้ง่ายขึ้น และสร้างบันทึกประจำรุ่นได้ง่ายขึ้น โปรเจ็กต์ Blockly ใช้คอมมิตแบบทั่วไปเพื่อช่วยในเรื่องนี้

แต่ละคอมมิตควรมีรูปแบบดังนี้

<type>: <description>

[optional body]

[optional footer(s)]

โปรดทราบว่าที่เก็บหลักของ Blockly มีโปรแกรมวิเคราะห์การยืนยันเพื่อช่วยบังคับใช้เรื่องนี้ หากคำขอพุลของคุณมีคอมมิตหลายรายการ โปรแกรมวิเคราะห์โค้ดจะตรวจสอบชื่อ หากมีคอมมิตเดียว ระบบจะตรวจสอบคอมมิตนั้น วิธีที่ดีที่สุดคือหากทั้งคอมมิตแต่ละรายการและชื่อคำขอดึงข้อมูลเป็นไปตามหลักเกณฑ์เหล่านี้

Type

ประเภทต้องไม่ว่างเปล่าและเป็นตัวพิมพ์เล็กทั้งหมด ต่อไปนี้เป็นรายการของประเภท ที่เรายอมรับ

งานบ้าน: สำหรับคอมมิตที่ทำงานที่เป็นกิจวัตร/การทำงานอัตโนมัติ เช่น การอัปเกรดทรัพยากร Dependency
เลิกใช้งาน: สำหรับคอมมิตที่เลิกใช้งานฟังก์ชันการทำงาน
feat: สำหรับคอมมิตที่เพิ่มฟังก์ชันใหม่ไปยัง Blockly
fix: สำหรับคอมมิตที่แก้ไขข้อบกพร่อง/ข้อผิดพลาดใน Blockly
ถอนการอ้างสิทธิ์: สำหรับคอมมิตที่เกี่ยวข้องกับการเปิดตัวเวอร์ชันใหม่

การเปลี่ยนแปลงที่ส่งผลกับส่วนอื่นในระบบ

สัญญาผูกมัดที่ทำการเปลี่ยนแปลงที่ส่งผลกับส่วนอื่นควรใส่ ! ต่อท้ายประเภทการคอมมิต การเปลี่ยนแปลงที่ส่งผลกับส่วนอื่นในระบบคือการเปลี่ยนแปลงที่อาจทำให้นักพัฒนาแอปที่ใช้ Blockly ในแอปของตนเสียหาย ซึ่งส่งผลให้นักพัฒนาแอปต้องทำงานเพิ่มเติม

ตัวอย่างเช่น fix!: return type of workspace.paste

การเปลี่ยนแปลงที่ส่งผลกับส่วนอื่นในระบบอาจมีประเภทที่ถูกต้องใดๆ ข้างต้น

คำอธิบาย

คำอธิบายต้องไม่ว่างเปล่าและต้องมีอักขระไม่เกิน 256 ตัว

เนื้อความ

ส่วนเนื้อความจะระบุหรือไม่ก็ได้ หากมีต้องมีช่องว่างระหว่างคำอธิบายกับคำอธิบาย โดยต้องแบ่งออกเป็นบรรทัดไม่เกิน 256 อักขระ

โปรดทราบว่าโดยปกติแล้ว เราขอแนะนำให้คุณใส่ข้อมูลประเภทนี้ในคำอธิบายคำขอพุลของคุณ นอกเหนือจาก/แทนในคอมมิตโดยตรง

คุณจะใส่ส่วนท้ายหรือไม่ก็ได้ ถ้ามีให้ใช้งาน ควรมีช่องว่างระหว่างเนื้อหากับส่วนเนื้อหา โดยต้องแบ่งออกเป็นบรรทัดไม่เกิน 256 อักขระ

การแก้ไขคอมมิตที่ไม่ใช่แบบทั่วไป

หากคุณไม่ได้ใช้คอมมิตแบบทั่วไปเมื่อทำการแก้ไขจะมี 2 ตัวเลือกในการแก้ไขข้อความโดยขึ้นอยู่กับจำนวนคอมมิตที่คุณมี ดังนี้

หากคำขอพุลของคุณมีคอมมิตหลายรายการ ให้แก้ไขชื่อคำขอพุลให้สอดคล้องกับข้อกำหนด เมื่อรวมคำขอพุลแล้ว ระบบจะบีบคอมมิตอื่นๆ เพื่อให้ชื่อกลายเป็นข้อความคอมมิต
หากคำขอพุลของคุณมีคอมมิตเดียว ให้แก้ไขข้อความคอมมิตโดยใช้ git commit --amend จากนั้นบังคับการเปลี่ยนแปลงไปยังทางแยกของ Blockly การดำเนินการนี้จะอัปเดตคำขอพุลทั้งหมดที่เปิดอยู่และเกี่ยวข้องกับ Branch นี้โดยอัตโนมัติ git push --force origin my-branch.